Testdroid REST API

Testdroid REST API.

Schemes:

Summary

Tag: account

Account

Operation	Description
GET /api/v2/users/{userId}/account	Get account

Tag: device

Device

Operation	Description
GET /api/v2/devices	Get the device list
GET /api/v2/devices/{id}/properties	Get the property list for device (model) with specific ID
GET /api/v2/devices/{deviceModelId}	Get device

Tag: file

File

Operation	Description
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files.zip	Get zip file with artifacts of user test run
GET /api/v2/files/{fileId}/tags	Get the file tags list
GET /api/v2/users/{userId}/files/{fileId}/file	Download file
GET /api/v2/projects/{projectId}/files.zip	Get zip file with artifacts of user project
POST /api/v2/users/{userId}/files	Upload file for authenticated user
GET /api/v2/users/{userId}/files	Get the file list of user with specific ID
POST /api/v2/users/{userId}/files/{fileId}	Update file name with specific id
DELETE /api/v2/users/{userId}/files/{fileId}	Delete file with specific ID
GET /api/v2/users/{userId}/files/{fileId}	Get user file with specific ID
POST /api/v2/file-sets	Create file set
GET /api/v2/file-sets	Get the file set list
GET /api/v2/projects/{projectId}/runs/{runId}/files.zip	Get zip file with artifacts of user test run
POST /api/v2/projects/{projectId}/files/test	Upload test file in user project
GET /api/v2/projects/{projectId}/files/test	Get test file in user project
POST /api/v2/users/{userId}/projects/{projectId}/files/data	Upload data file in user project
GET /api/v2/users/{userId}/projects/{projectId}/files/data	Get data file in user project
GET /api/v2/users/{userId}/files/{fileId}/tags	Get the file tags list
POST /api/v2/users/{userId}/file-sets/{fileSetId}	Update the file set of user with specific ID
DELETE /api/v2/users/{userId}/file-sets/{fileSetId}	Delete the file set of user with specific ID
GET /api/v2/users/{userId}/file-sets/{fileSetId}	Get the file set of user with specific ID
POST /api/v2/users/{userId}/file-sets/{fileSetId}/files	Add file to file set
GET /api/v2/users/{userId}/file-sets/{fileSetId}/files	Get file list of user file set
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files/application	Get application file in user project
GET /api/v2/runs/{runId}/files.zip	Get zip file with artifacts of user test run
GET /api/v2/users/{userId}/projects/{projectId}/files	Get list of files in user project
GET /api/v2/files/{fileId}/icon	Download icon of file
POST /api/v2/projects/{projectId}/files/data	Upload data file in user project
GET /api/v2/projects/{projectId}/files/data	Get data file in user project
POST /api/v2/users/{userId}/projects/{projectId}/files/test	Upload test file in user project
GET /api/v2/users/{userId}/projects/{projectId}/files/test	Get test file in user project
POST /api/v2/users/{userId}/file-sets	Create file set for user
GET /api/v2/users/{userId}/file-sets	Get the file set list of user with specific ID
GET /api/v2/projects/{projectId}/runs/{runId}/files/data	Get data file in user project
GET /api/v2/files/{fileId}/file	Download file
GET /api/v2/runs/{runId}/files/data	Get data file in user project
GET /api/v2/runs/{runId}/files/test	Get test file in user project
POST /api/v2/file-sets/{fileSetId}/files/{fileId}	Update file name with specific id
DELETE /api/v2/file-sets/{fileSetId}/files/{fileId}	Delete file from file set
GET /api/v2/file-sets/{fileSetId}/files/{fileId}	Get user file with specific ID
GET /api/v2/runs/{runId}/files/application/check-results	Get application file check results
GET /api/v2/projects/{projectId}/runs/{runId}/files/test	Get test file in user project
GET /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}/file	Download file from file set
POST /api/v2/files/{fileId}	Update file name with specific id
DELETE /api/v2/files/{fileId}	Delete file with specific ID
GET /api/v2/files/{fileId}	Get user file with specific ID
GET /api/v2/projects/{projectId}/runs/{runId}/files/application	Get application file in user project
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files/data	Get data file in user project
GET /api/v2/projects/{projectId}/runs/{runId}/files	Get list of files in user test run
GET /api/v2/file-sets/{fileSetId}/files/{fileId}/icon	Download icon of file from file set
POST /api/v2/file-sets/{fileSetId}/files	Add file to file set
GET /api/v2/file-sets/{fileSetId}/files	Get file list of file set
POST /api/v2/files	Upload file
GET /api/v2/files	Get the file list
GET /api/v2/users/{userId}/files/{fileId}/icon	Download icon of file
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files/application/check-results	Get application file in user project
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files/test	Get test file in user project
POST /api/v2/projects/{projectId}/files/application	Upload application file in user project
GET /api/v2/projects/{projectId}/files/application	Get application file in user project
GET /api/v2/users/{userId}/projects/{projectId}/files.zip	Get zip file with artifacts of user project
GET /api/v2/file-sets/{fileSetId}/files/{fileId}/file	Download file from file set
POST /api/v2/users/{userId}/projects/{projectId}/files/application	Upload application file in user project
GET /api/v2/users/{userId}/projects/{projectId}/files/application	Get application file in user project
GET /api/v2/projects/{projectId}/runs/{runId}/files/application/check-results	Get application file in user project
GET /api/v2/file-sets/{fileSetId}/files/{fileId}/tags	Get the file tags list
GET /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}/tags	Get the file tags list
POST /api/v2/file-sets/{fileSetId}	Update the file set with specific ID
DELETE /api/v2/file-sets/{fileSetId}	Delete the file set with specific ID
GET /api/v2/file-sets/{fileSetId}	Get the file set with specific ID
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files	Get list of files in user test run
GET /api/v2/projects/{projectId}/files	Get list of files in user project
GET /api/v2/runs/{runId}/files/application	Get application file in user project
POST /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}	Update file name with specific id
DELETE /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}	Delete file from file set
GET /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}	Get user file with specific ID
GET /api/v2/runs/{runId}/files	Get list of files in user test run
GET /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}/icon	Download icon of file from file set

Tag: device-group

Device Group

Operation	Description
POST /api/v2/device-groups/{deviceGroupId}/devices	Add device to device group
POST /api/v2/users/{userId}/device-groups/{deviceGroupId}	Update the device group of user with specific ID
DELETE /api/v2/users/{userId}/device-groups/{deviceGroupId}	Delete the device group of user with specific ID
GET /api/v2/users/{userId}/device-groups/{deviceGroupId}	Get the device group of user with specific ID
DELETE /api/v2/device-groups/{deviceGroupId}/devices/{deviceModelId}	Delete device from device group
GET /api/v2/device-groups	Get device groups
GET /api/v2/users/{userId}/projects/{projectId}/public-device-groups	Get public device groups for project
POST /api/v2/users/{userId}/device-groups/{deviceGroupId}/devices	Add device to device group
GET /api/v2/users/{userId}/device-groups/{deviceGroupId}/devices	Get device list of user device group
DELETE /api/v2/users/{userId}/device-groups/{deviceGroupId}/devices/{deviceId}	Delete device from device group
POST /api/v2/users/{id}/device-groups	Create device group for user
GET /api/v2/users/{id}/device-groups	Get the device group list of user with specific ID
GET /api/v2/projects/{projectId}/public-device-groups	Get public device groups for project

Tag: label

Label

Operation	Description
POST /api/v2/label-groups/{groupId}/labels	Add label into label group
GET /api/v2/label-groups/{groupId}/labels	Get the label list of label group
POST /api/v2/label-groups/{groupId}/labels/{labelId}/devices	Add device to label
GET /api/v2/label-groups/{groupId}/labels/{labelId}/devices	Get device list of label
DELETE /api/v2/label-groups/{groupId}/labels/{labelId}/devices/{deviceId}	Delete device from label
POST /api/v2/label-groups	Create label group
GET /api/v2/label-groups	Get the label group list
DELETE /api/v2/label-groups/{groupId}/labels/{labelId}	Delete label
GET /api/v2/label-groups/{groupId}/labels/{labelId}	Get the label from label group
POST /api/v2/label-groups/{id}	Update label group with specific ID
DELETE /api/v2/label-groups/{id}	Delete label group with specific ID
GET /api/v2/label-groups/{id}	Get label group with specific ID

Tag: account-service

Account service

Operation	Description
GET /api/v2/users/{userId}/billing-periods/{billingPeriodId}	Get billing period
GET /api/v2/users/{id}/device-time/reserved	Get reserved(status is WAITING or RUNNING) device time by user
POST /api/v2/services	Buy service
GET /api/v2/users/{id}/device-time/used	Get used(status is SUCCEEDED or FAILED) device time by user
DELETE /api/v2/users/{id}/services/{serviceId}	Cancel service subscription
GET /api/v2/users/{id}/device-time	Get device time history for user
POST /api/v2/users/{userId}/services	Buy service
GET /api/v2/users/{id}/services/purchased	Get all purchased services by user
GET /api/v2/users/{id}/services/available	Get all available services for selected user
GET /api/v2/users/{id}/services/active	Get all active services for selected user
GET /api/v2/services/available	Get all available services for any user
GET /api/v2/users/{userId}/billing-periods	Get users billing periods
GET /api/v2/users/{userId}/billing-periods/{billingPeriodId}/receipt	Get purchased service receipt
GET /api/v2/users/{userId}/account-services/{accountServiceId}/billing-period	Get billing information for billing period given by date

Tag: user

User

Operation	Description
POST /api/v2/users/recoveries	Generate recovery key for user
GET /api/v2/users/recoveries	Get user by recovery key
GET /api/v2/users/validateVatId	Is EU VAT ID correct
POST /api/v2/users/activate	Activate user after registration
POST /api/v2/users/{id}/reset-api-key	Reset api key
POST /api/v2/users/{userId}/account/additional-users/{additionalUserId}	Enable additional user
DELETE /api/v2/users/{userId}/account/additional-users/{additionalUserId}	Disable additional user
POST /api/v2/users/{userId}/notifications/{id}	Update the notification email of user with specific ID
DELETE /api/v2/users/{userId}/notifications/{id}	Delete the notification email of user with specific ID
GET /api/v2/users/{userId}/notifications/{id}	Get the notification email of user with specific ID
DELETE /api/v2/users/{id}/runs	Delete all test runs of user with specific ID
POST /api/v2/users/{userId}/notifications	Create the notification email of user
GET /api/v2/users/{userId}/notifications	Get the notification email list of user with specific id
POST /api/v2/projects/{projectId}/notifications	Create the notification email of user
GET /api/v2/projects/{projectId}/notifications	Get the notification email list of specified project
GET /api/v2/users/{id}/available-project-types	Get project types available for user
POST /api/v2/users/{userId}/account/additional-users	Add additional user
GET /api/v2/users/{userId}/account/additional-users	Get additional users
POST /api/v2/users/{userId}/ui-preferences	Store user ui preferences
GET /api/v2/users/{userId}/ui-preferences	Load user ui preferences
POST /api/v2/users/{userId}/projects/{projectId}/notifications	Create the notification email of user
GET /api/v2/users/{userId}/projects/{projectId}/notifications	Get the notification email list of user with specific id for specified project
POST /api/v2/users/password-recovery	Set new password after recovery
GET /api/v2/users/validate-activation	Check if activation or password reset link is valid
POST /api/v2/users/{userId}/feedback	Create feedback email from user
POST /api/v2/users/{userId}/log-activity	Log user activity
GET /api/v2/users/{userId}/receipts	Get receipt for users service
POST /api/v2/users/{id}	Update user with specific ID
GET /api/v2/users/{id}	Get user with specific ID

Tag: project

Project

Operation	Description
POST /api/v2/users/{userId}/projects/{projectId}/config	Update project test run config
GET /api/v2/users/{userId}/projects/{projectId}/config	Get project test run config
DELETE /api/v2/users/{userId}/projects/{projectId}/sharings/{sharingId}	Delete project sharing of user specified by ID
GET /api/v2/users/{userId}/projects/{projectId}/sharings/{sharingId}	Get project sharing of user specified by ID
DELETE /api/v2/users/{userId}/projects/{projectId}/config/parameters/{parameterId}	Delete project test run config parameter
GET /api/v2/users/{userId}/projects/{projectId}/config/parameters/{parameterId}	Get project test run config parameter
POST /api/v2/projects/{projectId}/job-configs/{type}	Updates project job config of given type
DELETE /api/v2/projects/{projectId}/job-configs/{type}	Rollbacks project job config of given type
GET /api/v2/projects/{projectId}/job-configs/{type}	Get project job config of given type
POST /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config/parameters	Add project test run config parameters
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config/parameters	Get project test run config parameters
POST /api/v2/runs/{runId}/config	Update test run config
GET /api/v2/runs/{runId}/config	Get test run config
GET /api/v2/projects/{projectId}/icon	Serves icon of project
GET /api/v2/runs/{runId}/config/parameters/{parameterId}	Get test run config parameter
POST /api/v2/projects/{projectId}/config	Update project test run config
GET /api/v2/projects/{projectId}/config	Get project test run config
POST /api/v2/projects/{projectId}/unarchive	Unarchive project with specific ID
POST /api/v2/users/{userId}/projects/{projectId}/config/parameters	Add project test run config parameters
GET /api/v2/users/{userId}/projects/{projectId}/config/parameters	Get project test run config parameters
POST /api/v2/users/{userId}/projects/{projectId}/sharings	Share project to specified by email
GET /api/v2/users/{userId}/projects/{projectId}/sharings	Get project sharings of user specified by ID
POST /api/v2/users/{id}/projects	Create project for authenticated user
GET /api/v2/users/{id}/projects	Get the project list of user with specific ID
POST /api/v2/projects/{projectId}/config/parameters	Add project test run config parameters
GET /api/v2/projects/{projectId}/config/parameters	Get project test run config parameters
GET /api/v2/users/{userId}/projects/{projectId}/device-groups	Get list of available device groups for project
POST /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config	Update test run config
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config	Get user test run config
DELETE /api/v2/projects/{projectId}/config/parameters/{parameterId}	Delete project test run config parameter
GET /api/v2/projects/{projectId}/config/parameters/{parameterId}	Get project test run config parameter
POST /api/v2/projects/{projectId}	Update user project with specific id
DELETE /api/v2/projects/{projectId}	Delete project with specific ID
GET /api/v2/projects/{projectId}	Get project with specific ID
GET /api/v2/projects/{projectId}/runs/{runId}/config/parameters	Get project test run config parameters
GET /api/v2/projects/{projectId}/runs/{runId}/config/parameters/{parameterId}	Get project test run config parameter
POST /api/v2/projects/{projectId}/runs/{runId}/config	Update test run config
GET /api/v2/projects/{projectId}/runs/{runId}/config	Get test run config
POST /api/v2/users/{userId}/projects/{projectId}	Update user project with specific id
DELETE /api/v2/users/{userId}/projects/{projectId}	Delete user project with specific ID
GET /api/v2/users/{userId}/projects/{projectId}	Get user project with specific ID
GET /api/v2/users/{userId}/projects/{projectId}/icon	Serves icon of user project
DELETE /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config/parameters/{parameterId}	Delete project test run config parameter
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config/parameters/{parameterId}	Get project test run config parameter
GET /api/v2/projects	Get the project list
GET /api/v2/projects/{projectId}/device-groups	Get list of available device groups for project
GET /api/v2/runs/{runId}/config/parameters	Get test run config parameters

Tag: report

Report

Operation	Description
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/reports/summary	Get summary report for test run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/reports/failures	Get failures report for test run
GET /api/v2/projects/{projectId}/runs/{runId}/reports/summary	Get summary report for test run
GET /api/v2/projects/{projectId}/runs/{runId}/reports/failures	Get failures report for test run
GET /api/v2/runs/{runId}/reports/failures	Get failures report for test run
GET /api/v2/runs/{runId}/reports/detail-failures	Get detail failures report for test run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/reports/cucumber	Get cucumber test run report for calabash project
GET /api/v2/users/{userId}/projects/{projectId}/reports/summary	Get summary report for project
GET /api/v2/projects/{projectId}/runs/{runId}/reports/detail-failures	Get detail failures report for test run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/reports/detail-failures	Get detail failures report for test run
GET /api/v2/runs/{runId}/reports/summary	Get summary report for test run
GET /api/v2/projects/{projectId}/reports/summary	Get summary report for project

Tag: license

License

Operation	Description
GET /api/v2/license	Get license installed to cloud

Tag: test-run

Test run

Operation	Description
POST /api/v2/projects/{projectId}/runs/{testRunId}/apps-data.zip	Request for generating apps and data zip from project
DELETE /api/v2/projects/{projectId}/runs/{testRunId}/tags/{tagId}	Delete test run tag
GET /api/v2/projects/{projectId}/runs/{testRunId}/tags/{tagId}	Get test run tag from test run
POST /api/v2/runs/{testRunId}/apps-data.zip	Request for generating apps and data zip from test run
POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/tags	Add test run tag to user's test run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/tags	Get test run tag list from user's test run
POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/performance.zip	Request for generating performance zip from user's test run
POST /api/v2/projects/{projectId}/runs/{testRunId}/logs.zip	Request for generating logs zip from project
POST /api/v2/runs/{testRunId}/retry	Retry test run or its device runs
GET /api/v2/projects/{projectId}/runs-extended	Get the test run list of user project
POST /api/v2/projects/{projectId}/runs/{runId}/abort	Abort test run from project, and receive partial results
POST /api/v2/projects/{projectId}/runs/{testRunId}/retry	Retry test run or its device runs
POST /api/v2/runs/{testRunId}/performance.zip	Request for generating performance zip from test run
POST /api/v2/runs/{testRunId}/build-logs.zip	Request for generating build logs zip from test run
GET /api/v2/projects/{id}/runs	Get project test run list
POST /api/v2/projects/{projectId}/runs/{testRunId}/tags	Add test run tag to test run
GET /api/v2/projects/{projectId}/runs/{testRunId}/tags	Get test run tag list from project test run
GET /api/v2/users/{userId}/projects/{projectId}/runs	Get the test run list of user project
GET /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/data-availability	Get test run data availability
POST /api/v2/projects/{projectId}/runs/{testRunId}/files.zip	Request for generating files zip from project
POST /api/v2/users/{id}/projects/{projectId}/runs	Run project for authenticated user using default project configuration
GET /api/v2/users/{id}/runs	Get the test run list of authenticated user
POST /api/v2/projects/{projectId}/runs/{testRunId}/build-logs.zip	Request for generating build logs zip from project's test run
DELETE /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/tags/{tagId}	Delete test run tag from user's test run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/tags/{tagId}	Get test run tag from user's test run
GET /api/v2/projects/{projectId}/runs/{testRunId}/data-availability	Get test run data availability
POST /api/v2/runs/{testRunId}/screenshots.zip	Request for generating screenshot zip from test run
POST /api/v2/projects/{projectId}/runs/{testRunId}/performance.zip	Request for generating performance zip from project's test run
POST /api/v2/projects/{projectId}/runs/{testRunId}/start	Start test run or its device runs
POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/files.zip	Request for generating files zip from user's test run
GET /api/v2/users/{userId}/projects/{projectId}/runs-extended/{runId}	Get extended test run from user project
GET /api/v2/users/{userId}/projects/{projectId}/runs-extended	Get the test run list of user project
POST /api/v2/projects/{projectId}/runs	Run project for authenticated user using default project configuration
POST /api/v2/runs/{testRunId}/files.zip	Request for generating files zip from test run
POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/logs.zip	Request for generating logs zip from user's test run
POST /api/v2/users/{userId}/projects/{projectId}/runs/{runId}	Update test run in user's project
DELETE /api/v2/users/{userId}/projects/{projectId}/runs/{runId}	Delete test run from user's project
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}	Get test run from user's project
POST /api/v2/runs	Create Testrun
GET /api/v2/runs	Get the test run list
GET /api/v2/runs/{testRunId}/data-availability	Get test run data availability
POST /api/v2/projects/{projectId}/runs/{testRunId}/screenshots.zip	Request for generating screenshot zip from project's test run
POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/start	Start test run
POST /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/abort	Abort test run from user's project, and receive partial results
POST /api/v2/projects/{projectId}/runs/{runId}	Update test run in project
DELETE /api/v2/projects/{projectId}/runs/{runId}	Delete test run from project
GET /api/v2/projects/{projectId}/runs/{runId}	Get test run from project
GET /api/v2/projects/{projectId}/runs-extended/{runId}	Get extended test run from user project
POST /api/v2/runs/{testRunId}/tags	Add tag to test run
GET /api/v2/runs/{testRunId}/tags	Get tag list from test run
POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/screenshots.zip	Request for generating screenshot zip from user's test run
POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/retry	Retry test run or its device runs
POST /api/v2/runs/{runId}/abort	Abort test run, and receive partial results
DELETE /api/v2/runs/{testRunId}/tags/{tagId}	Delete test run tag
GET /api/v2/runs/{testRunId}/tags/{tagId}	Get test run tag from user's test run
POST /api/v2/runs/{runId}	Update test run name
DELETE /api/v2/runs/{runId}	Delete test run
GET /api/v2/runs/{runId}	Get test run
POST /api/v2/runs/{testRunId}/start	Start test run or its device runs
POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/apps-data.zip	Request for generating apps and data zip from user's test run
POST /api/v2/runs/{testRunId}/logs.zip	Request for generating logs zip from test run

Tag: device-runs

Device Runs

Operation	Description
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs	Get the device run list of user test run
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/screenshots	Get the screenshot list of device run
GET /api/v2/device-runs/{deviceRunId}/fixtures.zip	Get device run fixtures.zip
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/junit.xml	Get device run junit file
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/result-data.zip	Get device run result data.zip
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}	Get the user device run
GET /api/v2/device-runs/{deviceRunId}/junit.xml	Get the device run junit file
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/states/{stateId}	Get the device run state of device run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/performance	Get the user device run performance file
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/states/{stateId}	Get the device run state of user device run
GET /api/v2/device-runs/{deviceRunId}/test-case-runs	Get device run steps
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}	Get device run
GET /api/v2/projects/{projectId}/runs/{runId}/screenshots	Get test run screenshots by name
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/states	Get the device run state list of the device run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/screenshots	Get test run screenshots by name
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/cluster-logs	Get cluster build logs file
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}	Get device run
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/result-data.zip	Get device run result data.zip
GET /api/v2/device-runs/{deviceRunId}/states	Get the device run state list of device run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/screenshots	Get the screenshot list of user device run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/data-availability	Get device run data availability
GET /api/v2/device-runs/{deviceRunId}/screenshots	Get the screenshot list of device run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/result-data.zip	Get the user device run result data file
GET /api/v2/device-runs/{deviceRunId}/logs	Get device run logs file
GET /api/v2/device-runs/{deviceRunId}/result-data.zip	Get device run result data.zip
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/states/{stateId}	Get the device run state of device run
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/data-availability	Get device run data availability
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/screenshots/{screenshotId}	Get screenshot
GET /api/v2/projects/{projectId}/runs/{runId}/screenshot-names	Get screenshot names
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/test-case-runs	Get device run steps
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/states	Get the device run state list of user device run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/screenshots/{screenshotId}	Get user screenshot
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/data-availability	Get device run data availability
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/screenshots/{screenshotId}	Get screenshot
GET /api/v2/device-runs/{deviceRunId}/screenshots/{screenshotId}	Get device run screenshot
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/screenshot-names	Get screenshot names
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/logs	Get the user device run logs file
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/performance	Get device run performance file
GET /api/v2/device-runs/{deviceRunId}	Get device run
GET /api/v2/runs/{runId}/screenshots	Get test run screenshots by name
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/screenshots	Get the screenshot list of device run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/test-case-runs	Get device run steps
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/junit.xml	Get the user device run junit file
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/cluster-logs	Get cluster build logs file
GET /api/v2/device-runs/{deviceRunId}/performance	Get the device run performance file
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/performance	Get device run performance file
GET /api/v2/device-runs/{deviceRunId}/data-availability	Get device run data availability
GET /api/v2/device-runs/{deviceRunId}/states/{stateId}	Get the device run state of device run
GET /api/v2/device-runs/{deviceRunId}/cluster-logs	Get cluster build logs file
GET /api/v2/runs/{runId}/screenshot-names	Get screenshot names
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/cluster-logs	Get the user cluster build logs file
GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/logs	Get device run logs file
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/logs	Get device run logs file
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/test-case-runs	Get device run steps
GET /api/v2/runs/{runId}/device-runs	Get the device run list of user test run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs	Get the device run list of user test run
GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/junit.xml	Get device run junit file
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/states	Get the device run state list of the device run

Tag: device-session

Device session

Operation	Description
GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files.zip	Get device session output files.zip
GET /api/v2/users/{userId}/device-sessions/{sessionId}/connections/{connectionId}	Get connection for Inspector device session
GET /api/v2/users/{userId}/device-sessions/{sessionId}	Get Inspector device session
POST /api/v2/users/{userId}/device-sessions/{sessionId}/connections	Create connection for device session
GET /api/v2/users/{userId}/device-sessions/{sessionId}/connections	Get connections for Inspector device session
GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots/{screenshotFileId}	Get screenshot for device session
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps/{deviceSessionStepId}	Get the device session step of device session
POST /api/v2/device-sessions/{sessionId}/connections	Create connection for device session
GET /api/v2/device-sessions/{sessionId}/connections	Get connections for Inspector device session
GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/steps/current	Get the current device session step of device session
POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots/screenshots.zip	Request for generating screenshot zip from user's Interactive device session
POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes	Add note to device session
GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes	Get notes for device session
GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions	Get the device session list of user test run
GET /api/v2/projects/{projectId}/runs/{testRunId}/steps	Get device session steps of all device sessions in run
GET /api/v2/device-sessions/{sessionId}/connections/{connectionId}	Get connection for Inspector device session
POST /api/v2/users/{userId}/device-sessions	Create Inspector device session
GET /api/v2/users/{userId}/device-sessions	Get Inspector device sessions
GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots/{screenshotFileId}/file	Download screenshot for device session
GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps/current	Get the current device session step of device session
POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots	Add screenshot to device session
GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots	Get screenshots for device session
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps	Get the device session steps of device session
GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/files.zip	Get device session output files.zip
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions	Get the device session list of user test run
GET /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/steps	Get device session steps of all device sessions in run
GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps	Get the device session steps of device session
POST /api/v2/device-sessions/{deviceSessionId}/release	Releases users device session
GET /api/v2/device-sessions/{deviceSessionId}/output-file-set/files.zip	Get device session output files.zip
POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/release	Releases users device session
GET /api/v2/device-sessions/{deviceSessionId}/input-file-set/files.zip	Get device session files.zip
POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes/{fileNoteId}	Update note for device session
DELETE /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes/{fileNoteId}	Delete note from device session
GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes/{fileNoteId}	Get note for device session
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps/current	Get the current device session step of device session
GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files	Get output files for device session by tag
GET /api/v2/runs/{runId}/device-sessions	Get the device session list of user test run
GET /api/v2/device-sessions/{deviceSessionId}/steps/current	Get the current device session step of device session
POST /api/v2/device-sessions/{deviceSessionId}/steps	Add or Update device session step
GET /api/v2/device-sessions/{deviceSessionId}/steps	Get the device session steps of device session
POST /api/v2/projects/{projectId}/runs/{testRunId}/device-sessions/{deviceSessionId}/retry	Retry session for device
GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files.zip	Get device session output files.zip
POST /api/v2/device-sessions/{deviceSessionId}/results.zip	Post results of a device session
GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files	Get output files for device session by tag
POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/device-sessions/{deviceSessionId}/retry	Retry session for device
DELETE /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots/{screenshotId}	Delete screenshot from device session
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files	Get output files for device session by tag
GET /api/v2/runs/{testRunId}/steps	Get device session steps of all device sessions in run
GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps/{deviceSessionStepId}	Get the device session step of device session
GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes/{fileNoteId}/file	Download note for device session
GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/steps/{deviceSessionStepId}	Get the device session step of device session
GET /api/v2/device-sessions/{deviceSessionId}/steps/{deviceSessionStepId}	Get the device session step of device session
GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/steps	Get the device session steps of device session
GET /api/v2/device-sessions/{deviceSessionId}/output-file-set/files	Get output files for device session by tag
GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files.zip	Get device session output files.zip

Tag: jira

Jira

Operation	Description
GET /api/v2/jira/issues/priorities	Get available jira issue priorities
GET /api/v2/jira/projects/{projectKey}	Get jira projects
POST /api/v2/users/{userId}/jira-account/{jiraAccountId}	Update jira account with specified jiraAccountId
DELETE /api/v2/users/{userId}/jira-account/{jiraAccountId}	Delete jira account with specified jiraAccountId
GET /api/v2/users/{userId}/jira-account/{jiraAccountId}	Get jira account with specified jiraAccountId
POST /api/v2/users/{userId}/jira-account/{jiraAccountId}/certificate	Update jira account certificate with specified jiraAccountId
GET /api/v2/jira/projects	Get jira projects
GET /api/v2/jira/issues/issue-types	Get available jira issue types
POST /api/v2/jira/projects/{projectKey}/issues	Create jira issue in project with specified projectId
GET /api/v2/jira/projects/{projectKey}/issues	Get jira issues by projectKey
POST /api/v2/jira/issues/{issueKey}	Update issue with specified issueKey
DELETE /api/v2/jira/issues/{issueKey}	Delete issue with specified issueKey
GET /api/v2/jira/issues/{issueKey}	Get issue with specified issueKey
POST /api/v2/users/{userId}/jira-account	Create jira account for user with userId
GET /api/v2/users/{userId}/jira-account	Get jira account for user with userId
GET /api/v2/jira/server-info	Get jira server info and validate connection

Paths

Get device groups

GET /api/v2/device-groups

Tags: device-group

application/json

*/*

200 OK: OK

APIList«APIDeviceGroup»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add device to device group

POST /api/v2/device-groups/{deviceGroupId}/devices

Tags: device-group

application/json


deviceGroupId	deviceGroupId	path	integer (int64)
deviceModelId	deviceModelId	query	integer (int64)

*/*

201 Created: Created

APIDeviceGroup
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete device from device group

DELETE /api/v2/device-groups/{deviceGroupId}/devices/{deviceModelId}

Tags: device-group

application/json


deviceGroupId	deviceGroupId	path	integer (int64)
deviceModelId	deviceModelId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get device run

GET /api/v2/device-runs/{deviceRunId}

Tags: device-runs

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK

APIDeviceRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get cluster build logs file

GET /api/v2/device-runs/{deviceRunId}/cluster-logs

Tags: device-runs

logs file as response body

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run data availability

GET /api/v2/device-runs/{deviceRunId}/data-availability

Tags: device-runs

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK

APIDeviceRunDataAvailability
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run fixtures.zip

GET /api/v2/device-runs/{deviceRunId}/fixtures.zip

Tags: device-runs

for cluster only

application/json


deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run junit file

GET /api/v2/device-runs/{deviceRunId}/junit.xml

Tags: device-runs

junit file as response body

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run logs file

GET /api/v2/device-runs/{deviceRunId}/logs

Tags: device-runs

logs file as response body

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run performance file

GET /api/v2/device-runs/{deviceRunId}/performance

Tags: device-runs

performance file as response body

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run result data.zip

GET /api/v2/device-runs/{deviceRunId}/result-data.zip

Tags: device-runs

result data.zip as response body

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the screenshot list of device run

GET /api/v2/device-runs/{deviceRunId}/screenshots

Tags: device-runs

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK

APIList«APIScreenshot»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run screenshot

GET /api/v2/device-runs/{deviceRunId}/screenshots/{screenshotId}

Tags: device-runs

screenshot file in response body

application/json


deviceRunId	deviceRunId	path	integer (int64)
screenshotId	screenshotId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)
width	width	query	integer (int32)
height	height	query	integer (int32)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run state list of device run

GET /api/v2/device-runs/{deviceRunId}/states

Tags: device-runs

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceRunState»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run state of device run

GET /api/v2/device-runs/{deviceRunId}/states/{stateId}

Tags: device-runs

application/json


deviceRunId	deviceRunId	path	integer (int64)
stateId	stepId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK

APIDeviceRunState
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run steps

GET /api/v2/device-runs/{deviceRunId}/test-case-runs

Tags: device-runs

application/json


deviceRunId	deviceRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

200 OK: OK

APIList«APITestCaseRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session files.zip

GET /api/v2/device-sessions/{deviceSessionId}/input-file-set/files.zip

Tags: device-session

for cluster only

application/json


deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get output files for device session by tag

GET /api/v2/device-sessions/{deviceSessionId}/output-file-set/files

Tags: device-session

application/json


deviceSessionId	deviceSessionId	path	integer (int64)
tag[]	tags	query	string[] , multiple parameters (`tag[]=aaa&tag[]=bbb`)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session output files.zip

GET /api/v2/device-sessions/{deviceSessionId}/output-file-set/files.zip

Tags: device-session

application/json


deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Releases users device session

POST /api/v2/device-sessions/{deviceSessionId}/release

Tags: device-session

application/json


deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSession
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Post results of a device session

POST /api/v2/device-sessions/{deviceSessionId}/results.zip

Tags: device-session

for cluster only

multipart/form-data


deviceSessionId	deviceSessionId	path	integer (int64)
file	file	formData	file

*/*

201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session steps of device session

GET /api/v2/device-sessions/{deviceSessionId}/steps

Tags: device-session

application/json


deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSessionStep»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add or Update device session step

POST /api/v2/device-sessions/{deviceSessionId}/steps

Tags: device-session

for clusters only

application/json


deviceSessionId	deviceSessionId	path	integer (int64)
type	type	query	string , x ∈ { WAITING , PREPARING , UNINSTALL , INSTALL , RUNNING , SENDING_RESULTS , PROCESSING_RESULTS }

*/*

201 Created: Created

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the current device session step of device session

GET /api/v2/device-sessions/{deviceSessionId}/steps/current

Tags: device-session

application/json


deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session step of device session

GET /api/v2/device-sessions/{deviceSessionId}/steps/{deviceSessionStepId}

Tags: device-session

application/json


deviceSessionId	deviceSessionId	path	integer (int64)
deviceSessionStepId	deviceSessionStepId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get connections for Inspector device session

GET /api/v2/device-sessions/{sessionId}/connections

Tags: device-session

application/json


sessionId	sessionId	path	integer (int64)

*/*

200 OK: OK

APIList«APIConnection»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create connection for device session

POST /api/v2/device-sessions/{sessionId}/connections

Tags: device-session

application/json


sessionId	sessionId	path	integer (int64)
host	host	query	string
port	port	query	integer (int32)
type	type	query	string
password	password	query	string

*/*

201 Created: Created

APIConnection
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get connection for Inspector device session

GET /api/v2/device-sessions/{sessionId}/connections/{connectionId}

Tags: device-session

application/json


sessionId	sessionId	path	integer (int64)
connectionId	connectionId	path	integer (int64)

*/*

200 OK: OK

APIConnection
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device list

GET /api/v2/devices

Tags: device

application/json


withDisabled	withDisabled	query	boolean
device_group_id[]	deviceGroupIds	query	integer[] , multiple parameters (`device_group_id[]=aaa&device_group_id[]=bbb`)
label_id[]	labelIds	query	integer[] , multiple parameters (`label_id[]=aaa&label_id[]=bbb`)
device_filter[]	filters	query	string[] , x ∈ { FREE , RECOMMENDED , NEW } , multiple parameters (`device_filter[]=aaa&device_filter[]=bbb`)

*/*

200 OK: OK

APIList«APIDevice»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device

GET /api/v2/devices/{deviceModelId}

Tags: device

application/json


deviceModelId	deviceModelId	path	integer (int64)
withDisabled	withDisabled	query	boolean

*/*

200 OK: OK

APIDevice
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the property list for device (model) with specific ID

GET /api/v2/devices/{id}/properties

Tags: device

application/json


id	id	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceProperty»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the file set list

GET /api/v2/file-sets

Tags: file

application/json

*/*

200 OK: OK

APIList«APIFileSet»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create file set

POST /api/v2/file-sets

Tags: file

application/json


name	name	query	string

*/*

201 Created: Created

APIFileSet
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete the file set with specific ID

DELETE /api/v2/file-sets/{fileSetId}

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get the file set with specific ID

GET /api/v2/file-sets/{fileSetId}

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)

*/*

200 OK: OK

APIFileSet
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update the file set with specific ID

POST /api/v2/file-sets/{fileSetId}

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)
name	name	query	string

*/*

200 OK: APIFileSet
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get file list of file set

GET /api/v2/file-sets/{fileSetId}/files

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add file to file set

POST /api/v2/file-sets/{fileSetId}/files

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)
fileId	fileId	query	integer (int64)

*/*

200 OK: APIFileSet
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete file from file set

DELETE /api/v2/file-sets/{fileSetId}/files/{fileId}

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: APIFileSet
204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get user file with specific ID

GET /api/v2/file-sets/{fileSetId}/files/{fileId}

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update file name with specific id

POST /api/v2/file-sets/{fileSetId}/files/{fileId}

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)
name	name	query	string

*/*

200 OK: APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download file from file set

GET /api/v2/file-sets/{fileSetId}/files/{fileId}/file

Tags: file

Returns file stream

application/json


fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download icon of file from file set

GET /api/v2/file-sets/{fileSetId}/files/{fileId}/icon

Tags: file

Returns file stream

application/json


fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the file tags list

GET /api/v2/file-sets/{fileSetId}/files/{fileId}/tags

Tags: file

application/json


fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUserFileTag»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the file list

GET /api/v2/files

Tags: file

application/json


tag[]	tags	query	string[] , multiple parameters (`tag[]=aaa&tag[]=bbb`)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Upload file

POST /api/v2/files

Tags: file

multipart/form-data


file	file	formData	file

*/*

201 Created: Created

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete file with specific ID

DELETE /api/v2/files/{fileId}

Tags: file

application/json


fileId	fileId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get user file with specific ID

GET /api/v2/files/{fileId}

Tags: file

application/json


fileId	fileId	path	integer (int64)

*/*

200 OK: OK

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update file name with specific id

POST /api/v2/files/{fileId}

Tags: file

application/json


fileId	fileId	path	integer (int64)
name	name	query	string

*/*

200 OK: APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download file

GET /api/v2/files/{fileId}/file

Tags: file

Returns file stream

application/json


fileId	fileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download icon of file

GET /api/v2/files/{fileId}/icon

Tags: file

Returns file stream

application/json


fileId	fileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the file tags list

GET /api/v2/files/{fileId}/tags

Tags: file

application/json


fileId	fileId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUserFileTag»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get available jira issue types

GET /api/v2/jira/issues/issue-types

Tags: jira

application/json

*/*

200 OK: OK

APIJiraIssueType
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get available jira issue priorities

GET /api/v2/jira/issues/priorities

Tags: jira

application/json

*/*

200 OK: OK

APIJiraPriority
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete issue with specified issueKey

DELETE /api/v2/jira/issues/{issueKey}

Tags: jira

application/json


issueKey	issueKey	path	string

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get issue with specified issueKey

GET /api/v2/jira/issues/{issueKey}

Tags: jira

application/json


issueKey	issueKey	path	string

*/*

200 OK: OK

APIJiraIssue
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update issue with specified issueKey

POST /api/v2/jira/issues/{issueKey}

Tags: jira

application/json


issueKey	issueKey	path	string
comment	comment	query	string

*/*

200 OK: APIJiraIssue
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get jira projects

GET /api/v2/jira/projects

Tags: jira

application/json

*/*

200 OK: OK

APIBasicJiraProject
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get jira projects

GET /api/v2/jira/projects/{projectKey}

Tags: jira

application/json


projectKey	projectKey	path	string

*/*

200 OK: OK

APIJiraProject
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get jira issues by projectKey

GET /api/v2/jira/projects/{projectKey}/issues

Tags: jira

application/json


projectKey	projectKey	path	string

*/*

200 OK: OK

APIList«APIJiraIssue»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create jira issue in project with specified projectId

POST /api/v2/jira/projects/{projectKey}/issues

Tags: jira

application/json


projectKey	projectKey	path	string
issueTypeId	issueTypeId	query	integer (int64)
summary	summary	query	string
description	description	query	string
priorityId	priorityId	query	integer (int64)

*/*

201 Created: Created

APIBasicJiraIssue
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get jira server info and validate connection

GET /api/v2/jira/server-info

Tags: jira

application/json

*/*

200 OK: OK

APIJiraServerInfo
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the label group list

GET /api/v2/label-groups

Tags: label

application/json

*/*

200 OK: OK

APIList«APILabelGroup»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create label group

POST /api/v2/label-groups

Tags: label

application/json


name	name	query	string
displayName	displayName	query	string

*/*

201 Created: Created

APILabelGroup
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the label list of label group

GET /api/v2/label-groups/{groupId}/labels

Tags: label

application/json


groupId	groupId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceProperty»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add label into label group

POST /api/v2/label-groups/{groupId}/labels

Tags: label

application/json


groupId	groupId	path	integer (int64)
name	name	query	string
displayName	displayName	query	string

*/*

201 Created: Created

APIDeviceProperty
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete label

DELETE /api/v2/label-groups/{groupId}/labels/{labelId}

Tags: label

application/json


groupId	groupId	path	integer (int64)
labelId	labelId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get the label from label group

GET /api/v2/label-groups/{groupId}/labels/{labelId}

Tags: label

application/json


groupId	groupId	path	integer (int64)
labelId	labelId	path	integer (int64)

*/*

200 OK: OK

APIDeviceProperty
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device list of label

GET /api/v2/label-groups/{groupId}/labels/{labelId}/devices

Tags: label

application/json


groupId	groupId	path	integer (int64)
labelId	labelId	path	integer (int64)

*/*

200 OK: OK

APIAdminList«APIAdminDevice»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add device to label

POST /api/v2/label-groups/{groupId}/labels/{labelId}/devices

Tags: label

application/json


groupId	groupId	path	integer (int64)
labelId	labelId	path	integer (int64)
id	deviceId	query	integer (int64)
removeExisting	removeExisting	query	boolean

*/*

201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete device from label

DELETE /api/v2/label-groups/{groupId}/labels/{labelId}/devices/{deviceId}

Tags: label

application/json


groupId	groupId	path	integer (int64)
labelId	labelId	path	integer (int64)
deviceId	deviceId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Delete label group with specific ID

DELETE /api/v2/label-groups/{id}

Tags: label

application/json


id	id	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get label group with specific ID

GET /api/v2/label-groups/{id}

Tags: label

application/json


id	id	path	integer (int64)

*/*

200 OK: OK

APILabelGroup
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update label group with specific ID

POST /api/v2/label-groups/{id}

Tags: label

application/json


id	id	path	integer (int64)
name	name	query	string
displayName	displayName	query	string
hidden	hidden	query	boolean

*/*

200 OK: OK

APILabelGroup
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get license installed to cloud

GET /api/v2/license

Tags: license

application/json

*/*

200 OK: OK

APILicense
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the project list

GET /api/v2/projects

Tags: project

application/json

*/*

200 OK: OK

APIList«APIProject»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project test run list

GET /api/v2/projects/{id}/runs

Tags: test-run

application/json


id	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete project with specific ID

DELETE /api/v2/projects/{projectId}

Tags: project

application/json


projectId	projectId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get project with specific ID

GET /api/v2/projects/{projectId}

Tags: project

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIProject
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update user project with specific id

POST /api/v2/projects/{projectId}

Tags: project

application/json


projectId	projectId	path	integer (int64)
name	name	query	string
description	description	query	string
common	common	query	boolean
archivingStrategy	archivingStrategy	query	string , x ∈ { NEVER , DAYS , RUNS }
archivingItemCount	archivingItemCount	query	integer (int32)

*/*

200 OK: APIProject
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project test run config

GET /api/v2/projects/{projectId}/config

Tags: project

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APITestRunConfig
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update project test run config

POST /api/v2/projects/{projectId}/config

Tags: project

application/json


projectId	projectId	path	integer (int64)
scheduler	scheduler	query	string , x ∈ { PARALLEL , SERIAL , SINGLE }
mode	mode	query	string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
autoScreenshots	autoScreenshots	query	boolean
screenshotDir	screenshotDir	query	string
limitationType	limitationType	query	string , x ∈ { PACKAGE , CLASS }
limitationValue	limitationValue	query	string
withAnnotation	withAnnotation	query	string
withoutAnnotation	withoutAnnotation	query	string
applicationUsername	applicationUsername	query	string
applicationPassword	applicationPassword	query	string
usedDeviceGroupId	usedDeviceGroupId	query	integer (int64)
deviceLanguageCode	deviceLanguageCode	query	string
hookURL	hookURL	query	string
uiAutomatorTestClasses	uiAutomatorTestClasses	query	string
launchApp	launchApp	query	boolean
instrumentationRunner	instrumentationRunner	query	string
appRequired	appRequired	query	boolean
gamebenchEnabled	gamebenchEnabled	query	boolean
videoRecordingEnabled	videoRecordingEnabled	query	boolean
useAdditionalFiles	useAdditionalFiles	query	boolean
timeout	timeout	query	integer (int64)

*/*

200 OK: OK

APITestRunConfig
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project test run config parameters

GET /api/v2/projects/{projectId}/config/parameters

Tags: project

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRunParameter»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add project test run config parameters

POST /api/v2/projects/{projectId}/config/parameters

Tags: project

application/json


projectId	projectId	path	integer (int64)
key	key	query	string
value	value	query	string

*/*

201 Created: Created

APITestRunParameter
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete project test run config parameter

DELETE /api/v2/projects/{projectId}/config/parameters/{parameterId}

Tags: project

application/json


projectId	projectId	path	integer (int64)
parameterId	parameterId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get project test run config parameter

GET /api/v2/projects/{projectId}/config/parameters/{parameterId}

Tags: project

application/json


projectId	projectId	path	integer (int64)
parameterId	parameterId	path	integer (int64)

*/*

200 OK: OK

APITestRunParameter
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get list of available device groups for project

GET /api/v2/projects/{projectId}/device-groups

Tags: project

Serves icon stream in response body

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceGroup»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get list of files in user project

GET /api/v2/projects/{projectId}/files

Tags: file

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIFiles
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get zip file with artifacts of user project

GET /api/v2/projects/{projectId}/files.zip

Tags: file

zip stream is returned

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get application file in user project

GET /api/v2/projects/{projectId}/files/application

Tags: file

Returns file stream

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Upload application file in user project

POST /api/v2/projects/{projectId}/files/application

Tags: file

multipart/form-data


projectId	projectId	path	integer (int64)
file	file	formData	file

*/*

201 Created: Created

APIFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get data file in user project

GET /api/v2/projects/{projectId}/files/data

Tags: file

Returns file stream

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Upload data file in user project

POST /api/v2/projects/{projectId}/files/data

Tags: file

multipart/form-data


projectId	projectId	path	integer (int64)
file	file	formData	file

*/*

201 Created: Created

APIFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test file in user project

GET /api/v2/projects/{projectId}/files/test

Tags: file

Returns file stream

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Upload test file in user project

POST /api/v2/projects/{projectId}/files/test

Tags: file

multipart/form-data


projectId	projectId	path	integer (int64)
file	file	formData	file

*/*

201 Created: Created

APIFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Serves icon of project

GET /api/v2/projects/{projectId}/icon

Tags: project

Serves icon stream in response body

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Rollbacks project job config of given type

DELETE /api/v2/projects/{projectId}/job-configs/{type}

Tags: project

application/json


projectId	projectId	path	integer (int64)
type	type	path	string , x ∈ { DEFAULT , INSTATEST , INTERACTIVE , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , TELERIK_ANDROID , TELERIK_IOS , GENERIC }

*/*

200 OK: OK

APIProjectJobConfig
204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get project job config of given type

GET /api/v2/projects/{projectId}/job-configs/{type}

Tags: project

If no project specific config exists, returns global job config of given type.

application/json


projectId	projectId	path	integer (int64)
type	type	path	string , x ∈ { DEFAULT , INSTATEST , INTERACTIVE , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , TELERIK_ANDROID , TELERIK_IOS , GENERIC }

*/*

200 OK: OK

APIProjectJobConfig
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Updates project job config of given type

POST /api/v2/projects/{projectId}/job-configs/{type}

Tags: project

application/json


projectId	projectId	path	integer (int64)
type	type	path	string , x ∈ { DEFAULT , INSTATEST , INTERACTIVE , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
content	content	query	string

*/*

200 OK: OK

APIProjectJobConfig
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the notification email list of specified project

GET /api/v2/projects/{projectId}/notifications

Tags: user

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APINotificationEmail»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create the notification email of user

POST /api/v2/projects/{projectId}/notifications

Tags: user

application/json


projectId	projectId	path	integer (int64)
email	email	query	string
type	type	query	string , x ∈ { ALWAYS , ON_FAILURE }

*/*

201 Created: Created

APINotificationEmail
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get public device groups for project

GET /api/v2/projects/{projectId}/public-device-groups

Tags: device-group

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceGroup»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get summary report for project

GET /api/v2/projects/{projectId}/reports/summary

Tags: report

application/json


projectId	projectId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Run project for authenticated user using default project configuration

POST /api/v2/projects/{projectId}/runs

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
name	name	query	string
usedDeviceIds[]	deviceIds	query	integer[] , multiple parameters (`usedDeviceIds[]=aaa&usedDeviceIds[]=bbb`)
scheduler	scheduler	query	string , x ∈ { PARALLEL , SERIAL , SINGLE }
mode	mode	query	string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
autoScreenshots	autoScreenshots	query	boolean
screenshotDir	screenshotDir	query	string
limitationType	limitationType	query	string , x ∈ { PACKAGE , CLASS }
limitationValue	limitationValue	query	string
withAnnotation	withAnnotation	query	string
withoutAnnotation	withoutAnnotation	query	string
applicationUsername	applicationUsername	query	string
applicationPassword	applicationPassword	query	string
usedDeviceGroupId	usedDeviceGroupId	query	integer (int64)
deviceLanguageCode	deviceLanguageCode	query	string
hookURL	hookURL	query	string
uiAutomatorTestClasses	uiAutomatorTestClasses	query	string
launchApp	launchApp	query	boolean
instrumentationRunner	instrumentationRunner	query	string
appRequired	appRequired	query	boolean
gamebenchEnabled	gamebenchEnabled	query	boolean
videoRecordingEnabled	videoRecordingEnabled	query	boolean
useAdditionalFiles	useAdditionalFiles	query	boolean
timeout	timeout	query	integer (int64)
appFileId	appFileId	query	integer (int64)
testFileId	testFileId	query	integer (int64)
dataFileId	dataFileId	query	integer (int64)

*/*

201 Created: Created

APITestRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the test run list of user project

GET /api/v2/projects/{projectId}/runs-extended

Tags: test-run

application/json


projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRunExtended»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get extended test run from user project

GET /api/v2/projects/{projectId}/runs-extended/{runId}

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APITestRunExtended
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete test run from project

DELETE /api/v2/projects/{projectId}/runs/{runId}

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get test run from project

GET /api/v2/projects/{projectId}/runs/{runId}

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APITestRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update test run in project

POST /api/v2/projects/{projectId}/runs/{runId}

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
displayName	displayName	query	string

*/*

200 OK: OK

APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Abort test run from project, and receive partial results

POST /api/v2/projects/{projectId}/runs/{runId}/abort

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run config

GET /api/v2/projects/{projectId}/runs/{runId}/config

Tags: project

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APITestRunConfig
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update test run config

POST /api/v2/projects/{projectId}/runs/{runId}/config

Tags: project

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
scheduler	scheduler	query	string , x ∈ { PARALLEL , SERIAL , SINGLE }
mode	mode	query	string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
autoScreenshots	autoScreenshots	query	boolean
screenshotDir	screenshotDir	query	string
limitationType	limitationType	query	string , x ∈ { PACKAGE , CLASS }
limitationValue	limitationValue	query	string
withAnnotation	withAnnotation	query	string
withoutAnnotation	withoutAnnotation	query	string
applicationUsername	applicationUsername	query	string
applicationPassword	applicationPassword	query	string
usedDeviceGroupId	usedDeviceGroupId	query	integer (int64)
deviceLanguageCode	deviceLanguageCode	query	string
hookURL	hookURL	query	string
uiAutomatorTestClasses	uiAutomatorTestClasses	query	string
launchApp	launchApp	query	boolean
instrumentationRunner	instrumentationRunner	query	string
appRequired	appRequired	query	boolean
timeout	timeout	query	integer (int64)

*/*

200 OK: OK

APITestRunConfig
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project test run config parameters

GET /api/v2/projects/{projectId}/runs/{runId}/config/parameters

Tags: project

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRunParameter»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project test run config parameter

GET /api/v2/projects/{projectId}/runs/{runId}/config/parameters/{parameterId}

Tags: project

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
parameterId	parameterId	path	integer (int64)

*/*

200 OK: OK

APITestRunParameter
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run list of user test run

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs

Tags: device-runs

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}

Tags: device-runs

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get cluster build logs file

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/cluster-logs

Tags: device-runs

logs file as response body

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run data availability

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/data-availability

Tags: device-runs

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRunDataAvailability
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run junit file

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/junit.xml

Tags: device-runs

junit file as response body

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run logs file

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/logs

Tags: device-runs

logs file as response body

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run performance file

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/performance

Tags: device-runs

performance file as response body

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run result data.zip

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/result-data.zip

Tags: device-runs

result data.zip as response body

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the screenshot list of device run

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/screenshots

Tags: device-runs

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIScreenshot»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get screenshot

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/screenshots/{screenshotId}

Tags: device-runs

screenshot file in response body

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)
screenshotId	screenshotId	path	integer (int64)
width	width	query	integer (int32)
height	height	query	integer (int32)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run state list of user device run

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/states

Tags: device-runs

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceRunState»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run state of device run

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/states/{stateId}

Tags: device-runs

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)
stateId	stateId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRunState
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run steps

GET /api/v2/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/test-case-runs

Tags: device-runs

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestCaseRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session list of user test run

GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions

Tags: device-session

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSession»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get output files for device session by tag

GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files

Tags: device-session

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
tag[]	tags	query	string[] , multiple parameters (`tag[]=aaa&tag[]=bbb`)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session output files.zip

GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files.zip

Tags: device-session

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session steps of device session

GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps

Tags: device-session

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSessionStep»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the current device session step of device session

GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps/current

Tags: device-session

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session step of device session

GET /api/v2/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps/{deviceSessionStepId}

Tags: device-session

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
deviceSessionStepId	deviceSessionStepId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get list of files in user test run

GET /api/v2/projects/{projectId}/runs/{runId}/files

Tags: file

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APIFiles
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get zip file with artifacts of user test run

GET /api/v2/projects/{projectId}/runs/{runId}/files.zip

Tags: file

zip stream is returned

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get application file in user project

GET /api/v2/projects/{projectId}/runs/{runId}/files/application

Tags: file

Returns file stream

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get application file in user project

GET /api/v2/projects/{projectId}/runs/{runId}/files/application/check-results

Tags: file

Returns file stream

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get data file in user project

GET /api/v2/projects/{projectId}/runs/{runId}/files/data

Tags: file

Returns file stream

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test file in user project

GET /api/v2/projects/{projectId}/runs/{runId}/files/test

Tags: file

Returns file stream

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get detail failures report for test run

GET /api/v2/projects/{projectId}/runs/{runId}/reports/detail-failures

Tags: report

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get failures report for test run

GET /api/v2/projects/{projectId}/runs/{runId}/reports/failures

Tags: report

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get summary report for test run

GET /api/v2/projects/{projectId}/runs/{runId}/reports/summary

Tags: report

application/json


projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get screenshot names

GET /api/v2/projects/{projectId}/runs/{runId}/screenshot-names

Tags: device-runs

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIScreenshot»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run screenshots by name

GET /api/v2/projects/{projectId}/runs/{runId}/screenshots

Tags: device-runs

application/json


projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
name	name	query	string

*/*

200 OK: OK

APIList«APIScreenshotExtended»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating apps and data zip from project

POST /api/v2/projects/{projectId}/runs/{testRunId}/apps-data.zip

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating build logs zip from project's test run

POST /api/v2/projects/{projectId}/runs/{testRunId}/build-logs.zip

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run data availability

GET /api/v2/projects/{projectId}/runs/{testRunId}/data-availability

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)

*/*

200 OK: OK

APITestRunDataAvailability
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Retry session for device

POST /api/v2/projects/{projectId}/runs/{testRunId}/device-sessions/{deviceSessionId}/retry

Tags: device-session

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: APIDeviceSession
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating files zip from project

POST /api/v2/projects/{projectId}/runs/{testRunId}/files.zip

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating logs zip from project

POST /api/v2/projects/{projectId}/runs/{testRunId}/logs.zip

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating performance zip from project's test run

POST /api/v2/projects/{projectId}/runs/{testRunId}/performance.zip

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Retry test run or its device runs

POST /api/v2/projects/{projectId}/runs/{testRunId}/retry

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating screenshot zip from project's test run

POST /api/v2/projects/{projectId}/runs/{testRunId}/screenshots.zip

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Start test run or its device runs

POST /api/v2/projects/{projectId}/runs/{testRunId}/start

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
usedDeviceIds[]	deviceIds	query	integer[] , multiple parameters (`usedDeviceIds[]=aaa&usedDeviceIds[]=bbb`)

*/*

200 OK: APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session steps of all device sessions in run

GET /api/v2/projects/{projectId}/runs/{testRunId}/steps

Tags: device-session

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSessionStep»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run tag list from project test run

GET /api/v2/projects/{projectId}/runs/{testRunId}/tags

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APITag»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add test run tag to test run

POST /api/v2/projects/{projectId}/runs/{testRunId}/tags

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
name	name	query	string

*/*

201 Created: Created

APITag
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete test run tag

DELETE /api/v2/projects/{projectId}/runs/{testRunId}/tags/{tagId}

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
tagId	tagId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get test run tag from test run

GET /api/v2/projects/{projectId}/runs/{testRunId}/tags/{tagId}

Tags: test-run

application/json


projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
tagId	tagId	path	integer (int64)

*/*

200 OK: OK

APITag
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Unarchive project with specific ID

POST /api/v2/projects/{projectId}/unarchive

Tags: project

application/json


projectId	projectId	path	integer (int64)

*/*

201 Created: Created
204 No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the test run list

GET /api/v2/runs

Tags: test-run

application/json

*/*

200 OK: OK

APIList«APITestRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create Testrun

POST /api/v2/runs

Tags: test-run

application/json


projectId	projectId	query	integer (int64)
name	name	query	string

*/*

201 Created: Created

APITestRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete test run

DELETE /api/v2/runs/{runId}

Tags: test-run

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get test run

GET /api/v2/runs/{runId}

Tags: test-run

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APITestRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update test run name

POST /api/v2/runs/{runId}

Tags: test-run

application/json


runId	runId	path	integer (int64)
displayName	displayName	query	string
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Abort test run, and receive partial results

POST /api/v2/runs/{runId}/abort

Tags: test-run

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run config

GET /api/v2/runs/{runId}/config

Tags: project

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APITestRunConfig
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update test run config

POST /api/v2/runs/{runId}/config

Tags: project

application/json


runId	testRunId	path	integer (int64)
scheduler	scheduler	query	string , x ∈ { PARALLEL , SERIAL , SINGLE }
mode	mode	query	string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
autoScreenshots	autoScreenshots	query	boolean
screenshotDir	screenshotDir	query	string
limitationType	limitationType	query	string , x ∈ { PACKAGE , CLASS }
limitationValue	limitationValue	query	string
withAnnotation	withAnnotation	query	string
withoutAnnotation	withoutAnnotation	query	string
applicationUsername	applicationUsername	query	string
applicationPassword	applicationPassword	query	string
usedDeviceGroupId	usedDeviceGroupId	query	integer (int64)
deviceLanguageCode	deviceLanguageCode	query	string
hookURL	hookURL	query	string
uiAutomatorTestClasses	uiAutomatorTestClasses	query	string
launchApp	launchApp	query	boolean
instrumentationRunner	instrumentationRunner	query	string
appRequired	appRequired	query	boolean
timeout	timeout	query	integer (int64)

*/*

200 OK: OK

APITestRunConfig
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run config parameters

GET /api/v2/runs/{runId}/config/parameters

Tags: project

application/json


runId	runId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRunParameter»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run config parameter

GET /api/v2/runs/{runId}/config/parameters/{parameterId}

Tags: project

application/json


runId	runId	path	integer (int64)
parameterId	parameterId	path	integer (int64)

*/*

200 OK: OK

APITestRunParameter
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run list of user test run

GET /api/v2/runs/{runId}/device-runs

Tags: device-runs

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}

Tags: device-runs

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get cluster build logs file

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/cluster-logs

Tags: device-runs

logs file as response body

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run data availability

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/data-availability

Tags: device-runs

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRunDataAvailability
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run junit file

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/junit.xml

Tags: device-runs

junit file as response body

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run logs file

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/logs

Tags: device-runs

logs file as response body

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run performance file

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/performance

Tags: device-runs

performance file as response body

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run result data.zip

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/result-data.zip

Tags: device-runs

result data.zip as response body

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the screenshot list of device run

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/screenshots

Tags: device-runs

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIScreenshot»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get screenshot

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/screenshots/{screenshotId}

Tags: device-runs

screenshot file in response body

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)
screenshotId	screenshotId	path	integer (int64)
width	width	query	integer (int32)
height	height	query	integer (int32)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run state list of the device run

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/states

Tags: device-runs

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceRunState»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run state of device run

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/states/{stateId}

Tags: device-runs

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)
stateId	stateId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRunState
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run steps

GET /api/v2/runs/{runId}/device-runs/{deviceRunId}/test-case-runs

Tags: device-runs

application/json


runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestCaseRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session list of user test run

GET /api/v2/runs/{runId}/device-sessions

Tags: device-session

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSession»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get output files for device session by tag

GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files

Tags: device-session

application/json


runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
tag[]	tags	query	string[] , multiple parameters (`tag[]=aaa&tag[]=bbb`)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session output files.zip

GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files.zip

Tags: device-session

application/json


runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session steps of device session

GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/steps

Tags: device-session

application/json


runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSessionStep»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the current device session step of device session

GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/steps/current

Tags: device-session

application/json


runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session step of device session

GET /api/v2/runs/{runId}/device-sessions/{deviceSessionId}/steps/{deviceSessionStepId}

Tags: device-session

application/json


runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
deviceSessionStepId	deviceSessionStepId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get list of files in user test run

GET /api/v2/runs/{runId}/files

Tags: file

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APIFiles
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get zip file with artifacts of user test run

GET /api/v2/runs/{runId}/files.zip

Tags: file

zip stream is returned

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get application file in user project

GET /api/v2/runs/{runId}/files/application

Tags: file

Returns file stream

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get application file check results

GET /api/v2/runs/{runId}/files/application/check-results

Tags: file

json stream returned

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get data file in user project

GET /api/v2/runs/{runId}/files/data

Tags: file

Returns file stream

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test file in user project

GET /api/v2/runs/{runId}/files/test

Tags: file

Returns file stream

application/json


runId	runId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get detail failures report for test run

GET /api/v2/runs/{runId}/reports/detail-failures

Tags: report

application/json


runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get failures report for test run

GET /api/v2/runs/{runId}/reports/failures

Tags: report

application/json


runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get summary report for test run

GET /api/v2/runs/{runId}/reports/summary

Tags: report

application/json


runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get screenshot names

GET /api/v2/runs/{runId}/screenshot-names

Tags: device-runs

application/json


runId	testRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIScreenshot»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run screenshots by name

GET /api/v2/runs/{runId}/screenshots

Tags: device-runs

application/json


runId	testRunId	path	integer (int64)
name	name	query	string

*/*

200 OK: OK

APIList«APIScreenshotExtended»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating apps and data zip from test run

POST /api/v2/runs/{testRunId}/apps-data.zip

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
userId	userId	query	integer (int64)
projectId	projectId	query	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating build logs zip from test run

POST /api/v2/runs/{testRunId}/build-logs.zip

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
userId	userId	query	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run data availability

GET /api/v2/runs/{testRunId}/data-availability

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
userId	userId	query	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APITestRunDataAvailability
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating files zip from test run

POST /api/v2/runs/{testRunId}/files.zip

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
userId	userId	query	integer (int64)
projectId	projectId	query	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating logs zip from test run

POST /api/v2/runs/{testRunId}/logs.zip

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
userId	userId	query	integer (int64)
projectId	projectId	query	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating performance zip from test run

POST /api/v2/runs/{testRunId}/performance.zip

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
userId	userId	query	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Retry test run or its device runs

POST /api/v2/runs/{testRunId}/retry

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating screenshot zip from test run

POST /api/v2/runs/{testRunId}/screenshots.zip

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
projectId	projectId	query	integer (int64)
userId	userId	query	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Start test run or its device runs

POST /api/v2/runs/{testRunId}/start

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
usedDeviceIds[]	deviceIds	query	integer[] , multiple parameters (`usedDeviceIds[]=aaa&usedDeviceIds[]=bbb`)

*/*

200 OK: APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session steps of all device sessions in run

GET /api/v2/runs/{testRunId}/steps

Tags: device-session

application/json


testRunId	testRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSessionStep»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get tag list from test run

GET /api/v2/runs/{testRunId}/tags

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APIList«APITag»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add tag to test run

POST /api/v2/runs/{testRunId}/tags

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
name	name	query	string
projectId	projectId	query	integer (int64)

*/*

201 Created: Created

APITag
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete test run tag

DELETE /api/v2/runs/{testRunId}/tags/{tagId}

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
tagId	tagId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get test run tag from user's test run

GET /api/v2/runs/{testRunId}/tags/{tagId}

Tags: test-run

application/json


testRunId	testRunId	path	integer (int64)
tagId	tagId	path	integer (int64)
projectId	projectId	query	integer (int64)

*/*

200 OK: OK

APITag
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Buy service

POST /api/v2/services

Tags: account-service

For not logged in users

application/json


serviceId	serviceId	query	integer (int64)
name	name	query	string
email	email	query	string
phone	phone	query	string
organization	organization	query	string
vat-id	vatId	query	string
country	country	query	string
city	city	query	string
state	state	query	string
address	address	query	string
zip	zip	query	string
paymentMethod	paymentMethod	query	string , x ∈ { PAYPAL , BRAINTREE , INVOICE , PROMOTION }
cardNumber	cardNumber	query	string
expirationDate	expirationDate	query	string
cvv	cvv	query	string
feedback	feedback	query	string

*/*

201 Created: Created

APIServicePaymentStatus
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get all available services for any user

GET /api/v2/services/available

Tags: account-service

For not logged in users

application/json

*/*

200 OK: OK

APIList«APIService»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Activate user after registration

POST /api/v2/users/activate

Tags: user

application/json


email	email	query	string
key	key	query	string
password	password	query	string
name	name	query	string
phone	phone	query	string
organization	organization	query	string
role	organizationRole	query	string , x ∈ { CEO_OR_OWNER , VP , MANAGER , INDIVIDUAL , QUALITY_ASSURANCE , DEVELOPER , MARKETING , CONSULTANT , OTHER }
hearFrom	hearFrom	query	string , x ∈ { COWORKER , EMAIL_CAMPAIGN , EVENT , ONLINE_COMMUNITY , SOCIAL_NETWORK , WEB_SEARCH , OTHER }
country	country	query	string
city	city	query	string
state	state	query	string
address	address	query	string
zip	zip	query	string
vat-id	vatId	query	string

*/*

200 OK: OK

APIUser
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Set new password after recovery

POST /api/v2/users/password-recovery

Tags: user

application/json


key	key	query	string
password	password	query	string

*/*

200 OK: OK

APIUser
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get user by recovery key

GET /api/v2/users/recoveries

Tags: user

application/json


recoveryKey	recoveryKey	query	string

*/*

200 OK: OK

APIUser
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Generate recovery key for user

POST /api/v2/users/recoveries

Tags: user

application/json


email	email	query	string

*/*

200 OK: OK

APIUser
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Check if activation or password reset link is valid

GET /api/v2/users/validate-activation

Tags: user

application/json


key	key	query	string

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Is EU VAT ID correct

GET /api/v2/users/validateVatId

Tags: user

application/json


countryCode	countryCode	query	string
vatId	vatId	query	string

*/*

200 OK: OK

string
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get user with specific ID

GET /api/v2/users/{id}

Tags: user

application/json


id	id	path	integer (int64)

*/*

200 OK: OK

APIUser
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update user with specific ID

POST /api/v2/users/{id}

Tags: user

application/json


id	id	path	integer (int64)
name	name	query	string
localeCountry	localeCountry	query	string
timeZone	timeZone	query	string
email	email	query	string
code	code	query	string
state	state	query	string
city	city	query	string
address	address	query	string
phone	phone	query	string
organization	organization	query	string
vatID	vatID	query	string
emailNotification	emailNotification	query	string , x ∈ { ALWAYS , NEVER , ON_FAILURE }
newPassword	newPassword	query	string
confirmPassword	confirmPassword	query	string

*/*

200 OK: OK

APIUser
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project types available for user

GET /api/v2/users/{id}/available-project-types

Tags: user

application/json


id	id	path	integer (int64)

*/*

200 OK: OK

APIArray«string»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device group list of user with specific ID

GET /api/v2/users/{id}/device-groups

Tags: device-group

application/json


id	userId	path	integer (int64)
withPublic	withPublic	query	boolean

*/*

200 OK: OK

APIList«APIDeviceGroup»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create device group for user

POST /api/v2/users/{id}/device-groups

Tags: device-group

application/json


id	userId	path	integer (int64)
name	name	query	string
osType	osType	query	string , x ∈ { IOS , ANDROID , UNDEFINED }

*/*

201 Created: Created

APIDeviceGroup
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device time history for user

GET /api/v2/users/{id}/device-time

Tags: account-service

application/json


id	userId	path	integer (int64)
withAdditionalUsers	withAdditionalUsers	query	boolean

*/*

200 OK: OK

APIUserDeviceTime
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get reserved(status is WAITING or RUNNING) device time by user

GET /api/v2/users/{id}/device-time/reserved

Tags: account-service

application/json


id	userId	path	integer (int64)

*/*

200 OK: OK

APIBasicDeviceTime
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get used(status is SUCCEEDED or FAILED) device time by user

GET /api/v2/users/{id}/device-time/used

Tags: account-service

application/json


id	userId	path	integer (int64)

*/*

200 OK: OK

APIBasicDeviceTime
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the project list of user with specific ID

GET /api/v2/users/{id}/projects

Tags: project

Owned projects + shared projects + public projects

application/json


id	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIProject»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create project for authenticated user

POST /api/v2/users/{id}/projects

Tags: project

application/json


id	userId	path	integer (int64)
name	name	query	string
type	type	query	string , x ∈ { ANDROID , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
mode	mode	query	string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }

*/*

201 Created: Created

APIProject
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Run project for authenticated user using default project configuration

POST /api/v2/users/{id}/projects/{projectId}/runs

Tags: test-run

application/json


id	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
name	name	query	string
usedDeviceIds[]	deviceIds	query	integer[] , multiple parameters (`usedDeviceIds[]=aaa&usedDeviceIds[]=bbb`)
scheduler	scheduler	query	string , x ∈ { PARALLEL , SERIAL , SINGLE }
mode	mode	query	string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
autoScreenshots	autoScreenshots	query	boolean
screenshotDir	screenshotDir	query	string
limitationType	limitationType	query	string , x ∈ { PACKAGE , CLASS }
limitationValue	limitationValue	query	string
withAnnotation	withAnnotation	query	string
withoutAnnotation	withoutAnnotation	query	string
applicationUsername	applicationUsername	query	string
applicationPassword	applicationPassword	query	string
usedDeviceGroupId	usedDeviceGroupId	query	integer (int64)
deviceLanguageCode	deviceLanguageCode	query	string
hookURL	hookURL	query	string
uiAutomatorTestClasses	uiAutomatorTestClasses	query	string
launchApp	launchApp	query	boolean
instrumentationRunner	instrumentationRunner	query	string
appRequired	appRequired	query	boolean
gamebenchEnabled	gamebenchEnabled	query	boolean
videoRecordingEnabled	videoRecordingEnabled	query	boolean
useAdditionalFiles	useAdditionalFiles	query	boolean
timeout	timeout	query	integer (int64)
appFileId	appFileId	query	integer (int64)
testFileId	testFileId	query	integer (int64)
dataFileId	dataFileId	query	integer (int64)
testRunId	testRunId	query	integer (int64)

*/*

201 Created: Created

APITestRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Reset api key

POST /api/v2/users/{id}/reset-api-key

Tags: user

application/json


id	id	path	integer (int64)

*/*

200 OK: OK

APIUser
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete all test runs of user with specific ID

DELETE /api/v2/users/{id}/runs

Tags: user

application/json


id	userId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get the test run list of authenticated user

GET /api/v2/users/{id}/runs

Tags: test-run

application/json


id	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get all active services for selected user

GET /api/v2/users/{id}/services/active

Tags: account-service

application/json


id	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIAccountService»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get all available services for selected user

GET /api/v2/users/{id}/services/available

Tags: account-service

application/json


id	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIService»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get all purchased services by user

GET /api/v2/users/{id}/services/purchased

Tags: account-service

application/json


id	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIAccountService»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Cancel service subscription

DELETE /api/v2/users/{id}/services/{serviceId}

Tags: account-service

application/json


id	userId	path	integer (int64)
serviceId	serviceId	path	integer (int64)

*/*

200 OK: OK

APIServicePaymentStatus
204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get account

GET /api/v2/users/{userId}/account

Tags: account

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIAccount
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get billing information for billing period given by date

GET /api/v2/users/{userId}/account-services/{accountServiceId}/billing-period

Tags: account-service

application/json


userId	userId	path	integer (int64)
accountServiceId	accountServiceId	path	integer (int64)
onDate	timestamp	query	integer (int64)

*/*

200 OK: OK

APIAccountServicePayment
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get additional users

GET /api/v2/users/{userId}/account/additional-users

Tags: user

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUser»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add additional user

POST /api/v2/users/{userId}/account/additional-users

Tags: user

application/json


userId	userId	path	integer (int64)
email	email	query	string
password	password	query	string

*/*

200 OK: OK

APIUser
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Disable additional user

DELETE /api/v2/users/{userId}/account/additional-users/{additionalUserId}

Tags: user

application/json


userId	userId	path	integer (int64)
additionalUserId	additionalUserId	path	integer (int64)

*/*

200 OK: OK

APIUser
204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Enable additional user

POST /api/v2/users/{userId}/account/additional-users/{additionalUserId}

Tags: user

application/json


userId	userId	path	integer (int64)
additionalUserId	additionalUserId	path	integer (int64)

*/*

200 OK: OK

APIUser
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get users billing periods

GET /api/v2/users/{userId}/billing-periods

Tags: account-service

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIBillingPeriod»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get billing period

GET /api/v2/users/{userId}/billing-periods/{billingPeriodId}

Tags: account-service

application/json


userId	userId	path	integer (int64)
billingPeriodId	billingPeriodId	path	integer (int64)

*/*

200 OK: OK

APIBillingPeriod
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get purchased service receipt

GET /api/v2/users/{userId}/billing-periods/{billingPeriodId}/receipt

Tags: account-service

application/json


userId	userId	path	integer (int64)
billingPeriodId	billingPeriodId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete the device group of user with specific ID

DELETE /api/v2/users/{userId}/device-groups/{deviceGroupId}

Tags: device-group

application/json


userId	userId	path	integer (int64)
deviceGroupId	deviceGroupId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get the device group of user with specific ID

GET /api/v2/users/{userId}/device-groups/{deviceGroupId}

Tags: device-group

application/json


userId	userId	path	integer (int64)
deviceGroupId	deviceGroupId	path	integer (int64)

*/*

200 OK: OK

APIDeviceGroup
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update the device group of user with specific ID

POST /api/v2/users/{userId}/device-groups/{deviceGroupId}

Tags: device-group

application/json


userId	userId	path	integer (int64)
deviceGroupId	deviceGroupId	path	integer (int64)
name	name	query	string
osType	osType	query	string , x ∈ { IOS , ANDROID , UNDEFINED }

*/*

200 OK: APIDeviceGroup
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device list of user device group

GET /api/v2/users/{userId}/device-groups/{deviceGroupId}/devices

Tags: device-group

application/json


userId	userId	path	integer (int64)
deviceGroupId	deviceGroupId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDevice»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add device to device group

POST /api/v2/users/{userId}/device-groups/{deviceGroupId}/devices

Tags: device-group

application/json


userId	userId	path	integer (int64)
deviceGroupId	deviceGroupId	path	integer (int64)
deviceId	deviceModelId	query	integer (int64)

*/*

201 Created: Created

APIDeviceGroup
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete device from device group

DELETE /api/v2/users/{userId}/device-groups/{deviceGroupId}/devices/{deviceId}

Tags: device-group

application/json


userId	userId	path	integer (int64)
deviceGroupId	deviceGroupId	path	integer (int64)
deviceId	deviceModelId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get Inspector device sessions

GET /api/v2/users/{userId}/device-sessions

Tags: device-session

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSession»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create Inspector device session

POST /api/v2/users/{userId}/device-sessions

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceModelId	deviceModelId	query	integer (int64)
fileSetId	fileSetId	query	integer (int64)
url	url	query	string
timeout	timeout	query	integer (int64)

*/*

201 Created: Created

APIDeviceSession
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session output files.zip

GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/files.zip

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get notes for device session

GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add note to device session

POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes

Tags: device-session

Note is stored as APIUserFile within output file set

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
name	name	query	string
content	content	query	string

*/*

201 Created: Created

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete note from device session

DELETE /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes/{fileNoteId}

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
fileNoteId	fileNoteId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get note for device session

GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes/{fileNoteId}

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
fileNoteId	fileNoteId	path	integer (int64)

*/*

200 OK: OK

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update note for device session

POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes/{fileNoteId}

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
fileNoteId	fileNoteId	path	integer (int64)
name	name	query	string
content	content	query	string

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download note for device session

GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/notes/{fileNoteId}/file

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
fileNoteId	fileNoteId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get screenshots for device session

GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add screenshot to device session

POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots

Tags: device-session

Screenshot is stored as APIUserFile within output file set.

multipart/form-data


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
name	name	query	string
screenshot	screenshot	formData	file

*/*

201 Created: Created

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating screenshot zip from user's Interactive device session

POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots/screenshots.zip

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get screenshot for device session

GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots/{screenshotFileId}

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
screenshotFileId	screenshotFileId	path	integer (int64)

*/*

200 OK: OK

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download screenshot for device session

GET /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots/{screenshotFileId}/file

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
screenshotFileId	screenshotFileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete screenshot from device session

DELETE /api/v2/users/{userId}/device-sessions/{deviceSessionId}/output-file-set/screenshots/{screenshotId}

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
screenshotId	screenshotId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Releases users device session

POST /api/v2/users/{userId}/device-sessions/{deviceSessionId}/release

Tags: device-session

application/json


userId	userId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSession
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get Inspector device session

GET /api/v2/users/{userId}/device-sessions/{sessionId}

Tags: device-session

application/json


userId	userId	path	integer (int64)
sessionId	sessionId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSession
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get connections for Inspector device session

GET /api/v2/users/{userId}/device-sessions/{sessionId}/connections

Tags: device-session

application/json


userId	userId	path	integer (int64)
sessionId	sessionId	path	integer (int64)

*/*

200 OK: OK

APIList«APIConnection»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create connection for device session

POST /api/v2/users/{userId}/device-sessions/{sessionId}/connections

Tags: device-session

application/json


userId	userId	path	integer (int64)
sessionId	sessionId	path	integer (int64)
host	host	query	string
port	port	query	integer (int32)
type	type	query	string
password	password	query	string

*/*

201 Created: Created

APIConnection
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get connection for Inspector device session

GET /api/v2/users/{userId}/device-sessions/{sessionId}/connections/{connectionId}

Tags: device-session

application/json


userId	userId	path	integer (int64)
sessionId	sessionId	path	integer (int64)
connectionId	connectionId	path	integer (int64)

*/*

200 OK: OK

APIConnection
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create feedback email from user

POST /api/v2/users/{userId}/feedback

Tags: user

multipart/form-data


userId	userId	path	integer (int64)
content	content	query	string
file	file	formData	file

*/*

201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the file set list of user with specific ID

GET /api/v2/users/{userId}/file-sets

Tags: file

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIFileSet»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create file set for user

POST /api/v2/users/{userId}/file-sets

Tags: file

application/json


userId	userId	path	integer (int64)
name	name	query	string

*/*

201 Created: Created

APIFileSet
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete the file set of user with specific ID

DELETE /api/v2/users/{userId}/file-sets/{fileSetId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get the file set of user with specific ID

GET /api/v2/users/{userId}/file-sets/{fileSetId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)

*/*

200 OK: OK

APIFileSet
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update the file set of user with specific ID

POST /api/v2/users/{userId}/file-sets/{fileSetId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)
name	name	query	string

*/*

200 OK: APIFileSet
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get file list of user file set

GET /api/v2/users/{userId}/file-sets/{fileSetId}/files

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add file to file set

POST /api/v2/users/{userId}/file-sets/{fileSetId}/files

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)
fileId	fileId	query	integer (int64)

*/*

200 OK: APIFileSet
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete file from file set

DELETE /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: APIFileSet
204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get user file with specific ID

GET /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update file name with specific id

POST /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)
name	name	query	string

*/*

200 OK: APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download file from file set

GET /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}/file

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download icon of file from file set

GET /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}/icon

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the file tags list

GET /api/v2/users/{userId}/file-sets/{fileSetId}/files/{fileId}/tags

Tags: file

application/json


userId	userId	path	integer (int64)
fileSetId	fileSetId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUserFileTag»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the file list of user with specific ID

GET /api/v2/users/{userId}/files

Tags: file

Owned files

application/json


userId	userId	path	integer (int64)
tag[]	tags	query	string[] , multiple parameters (`tag[]=aaa&tag[]=bbb`)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Upload file for authenticated user

POST /api/v2/users/{userId}/files

Tags: file

multipart/form-data


userId	userId	path	integer (int64)
file	file	formData	file

*/*

201 Created: Created

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete file with specific ID

DELETE /api/v2/users/{userId}/files/{fileId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get user file with specific ID

GET /api/v2/users/{userId}/files/{fileId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK

APIUserFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update file name with specific id

POST /api/v2/users/{userId}/files/{fileId}

Tags: file

application/json


userId	userId	path	integer (int64)
fileId	fileId	path	integer (int64)
name	name	query	string

*/*

200 OK: APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download file

GET /api/v2/users/{userId}/files/{fileId}/file

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Download icon of file

GET /api/v2/users/{userId}/files/{fileId}/icon

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the file tags list

GET /api/v2/users/{userId}/files/{fileId}/tags

Tags: file

application/json


userId	userId	path	integer (int64)
fileId	fileId	path	integer (int64)

*/*

200 OK: OK

APIList«APIUserFileTag»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get jira account for user with userId

GET /api/v2/users/{userId}/jira-account

Tags: jira

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIJiraAccount
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create jira account for user with userId

POST /api/v2/users/{userId}/jira-account

Tags: jira

application/json


userId	userId	path	integer (int64)
username	username	query	string
password	password	query	string
jiraUrl	jiraUrl	query	string

*/*

201 Created: Created

APIJiraAccount
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete jira account with specified jiraAccountId

DELETE /api/v2/users/{userId}/jira-account/{jiraAccountId}

Tags: jira

application/json


userId	userId	path	integer (int64)
jiraAccountId	jiraAccountId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get jira account with specified jiraAccountId

GET /api/v2/users/{userId}/jira-account/{jiraAccountId}

Tags: jira

application/json


userId	userId	path	integer (int64)
jiraAccountId	jiraAccountId	path	integer (int64)

*/*

200 OK: OK

APIJiraAccount
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update jira account with specified jiraAccountId

POST /api/v2/users/{userId}/jira-account/{jiraAccountId}

Tags: jira

application/json


userId	userId	path	integer (int64)
jiraAccountId	jiraAccountId	path	integer (int64)
username	username	query	string
password	password	query	string
jiraUrl	jiraUrl	query	string

*/*

200 OK: APIJiraAccount
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update jira account certificate with specified jiraAccountId

POST /api/v2/users/{userId}/jira-account/{jiraAccountId}/certificate

Tags: jira

multipart/form-data


userId	userId	path	integer (int64)
jiraAccountId	jiraAccountId	path	integer (int64)
jiraCert	jiraCert	formData	file

*/*

200 OK: APIJiraAccount
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Log user activity

POST /api/v2/users/{userId}/log-activity

Tags: user

application/json


userId	userId	path	integer (int64)
applicationType	applicationType	query	string , x ∈ { RECORDER }
eventType	eventType	query	string , x ∈ { RECORDER_OPEN_WIZARD , RECORDER_RUN_IN_CLOUD , RECORDER_FINISH_WIZARD , RECORDER_RUN_APPCRAWLER }

*/*

200 OK: OK

APIEvent
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the notification email list of user with specific id

GET /api/v2/users/{userId}/notifications

Tags: user

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APINotificationEmail»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create the notification email of user

POST /api/v2/users/{userId}/notifications

Tags: user

application/json


userId	userId	path	integer (int64)
email	email	query	string
type	type	query	string , x ∈ { ALWAYS , ON_FAILURE }

*/*

201 Created: Created

APINotificationEmail
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete the notification email of user with specific ID

DELETE /api/v2/users/{userId}/notifications/{id}

Tags: user

application/json


userId	userId	path	integer (int64)
id	id	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get the notification email of user with specific ID

GET /api/v2/users/{userId}/notifications/{id}

Tags: user

application/json


userId	userId	path	integer (int64)
id	id	path	integer (int64)

*/*

200 OK: OK

APINotificationEmail
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update the notification email of user with specific ID

POST /api/v2/users/{userId}/notifications/{id}

Tags: user

application/json


userId	userId	path	integer (int64)
id	id	path	integer (int64)
type	type	query	string , x ∈ { ALWAYS , ON_FAILURE }

*/*

200 OK: OK

APINotificationEmail
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete user project with specific ID

DELETE /api/v2/users/{userId}/projects/{projectId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get user project with specific ID

GET /api/v2/users/{userId}/projects/{projectId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIProject
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update user project with specific id

POST /api/v2/users/{userId}/projects/{projectId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
name	name	query	string
description	description	query	string
common	common	query	boolean
archivingStrategy	archivingStrategy	query	string , x ∈ { NEVER , DAYS , RUNS }
archivingItemCount	archivingItemCount	query	integer (int32)

*/*

200 OK: APIProject
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project test run config

GET /api/v2/users/{userId}/projects/{projectId}/config

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APITestRunConfig
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update project test run config

POST /api/v2/users/{userId}/projects/{projectId}/config

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
scheduler	scheduler	query	string , x ∈ { PARALLEL , SERIAL , SINGLE }
mode	mode	query	string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
autoScreenshots	autoScreenshots	query	boolean
screenshotDir	screenshotDir	query	string
limitationType	limitationType	query	string , x ∈ { PACKAGE , CLASS }
limitationValue	limitationValue	query	string
withAnnotation	withAnnotation	query	string
withoutAnnotation	withoutAnnotation	query	string
applicationUsername	applicationUsername	query	string
applicationPassword	applicationPassword	query	string
usedDeviceGroupId	usedDeviceGroupId	query	integer (int64)
deviceLanguageCode	deviceLanguageCode	query	string
hookURL	hookURL	query	string
uiAutomatorTestClasses	uiAutomatorTestClasses	query	string
launchApp	launchApp	query	boolean
instrumentationRunner	instrumentationRunner	query	string
appRequired	appRequired	query	boolean
gamebenchEnabled	gamebenchEnabled	query	boolean
videoRecordingEnabled	videoRecordingEnabled	query	boolean
useAdditionalFiles	useAdditionalFiles	query	boolean
timeout	timeout	query	integer (int64)

*/*

200 OK: OK

APITestRunConfig
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project test run config parameters

GET /api/v2/users/{userId}/projects/{projectId}/config/parameters

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRunParameter»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add project test run config parameters

POST /api/v2/users/{userId}/projects/{projectId}/config/parameters

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
key	key	query	string
value	value	query	string

*/*

201 Created: Created

APITestRunParameter
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete project test run config parameter

DELETE /api/v2/users/{userId}/projects/{projectId}/config/parameters/{parameterId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
parameterId	parameterId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get project test run config parameter

GET /api/v2/users/{userId}/projects/{projectId}/config/parameters/{parameterId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
parameterId	parameterId	path	integer (int64)

*/*

200 OK: OK

APITestRunParameter
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get list of available device groups for project

GET /api/v2/users/{userId}/projects/{projectId}/device-groups

Tags: project

Serves icon stream in response body

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceGroup»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get list of files in user project

GET /api/v2/users/{userId}/projects/{projectId}/files

Tags: file

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIFiles
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get zip file with artifacts of user project

GET /api/v2/users/{userId}/projects/{projectId}/files.zip

Tags: file

zip stream is returned

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get application file in user project

GET /api/v2/users/{userId}/projects/{projectId}/files/application

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Upload application file in user project

POST /api/v2/users/{userId}/projects/{projectId}/files/application

Tags: file

multipart/form-data


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
file	file	formData	file

*/*

201 Created: Created

APIFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get data file in user project

GET /api/v2/users/{userId}/projects/{projectId}/files/data

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Upload data file in user project

POST /api/v2/users/{userId}/projects/{projectId}/files/data

Tags: file

multipart/form-data


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
file	file	formData	file

*/*

201 Created: Created

APIFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test file in user project

GET /api/v2/users/{userId}/projects/{projectId}/files/test

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Upload test file in user project

POST /api/v2/users/{userId}/projects/{projectId}/files/test

Tags: file

multipart/form-data


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
file	file	formData	file

*/*

201 Created: Created

APIFile
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Serves icon of user project

GET /api/v2/users/{userId}/projects/{projectId}/icon

Tags: project

Serves icon stream in response body

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the notification email list of user with specific id for specified project

GET /api/v2/users/{userId}/projects/{projectId}/notifications

Tags: user

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APINotificationEmail»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Create the notification email of user

POST /api/v2/users/{userId}/projects/{projectId}/notifications

Tags: user

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
email	email	query	string
type	type	query	string , x ∈ { ALWAYS , ON_FAILURE }

*/*

201 Created: Created

APINotificationEmail
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get public device groups for project

GET /api/v2/users/{userId}/projects/{projectId}/public-device-groups

Tags: device-group

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceGroup»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get summary report for project

GET /api/v2/users/{userId}/projects/{projectId}/reports/summary

Tags: report

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the test run list of user project

GET /api/v2/users/{userId}/projects/{projectId}/runs

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the test run list of user project

GET /api/v2/users/{userId}/projects/{projectId}/runs-extended

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRunExtended»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get extended test run from user project

GET /api/v2/users/{userId}/projects/{projectId}/runs-extended/{runId}

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APITestRunExtended
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete test run from user's project

DELETE /api/v2/users/{userId}/projects/{projectId}/runs/{runId}

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get test run from user's project

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APITestRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update test run in user's project

POST /api/v2/users/{userId}/projects/{projectId}/runs/{runId}

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
displayName	displayName	query	string

*/*

200 OK: OK

APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Abort test run from user's project, and receive partial results

POST /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/abort

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get user test run config

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APITestRunConfig
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Update test run config

POST /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
scheduler	scheduler	query	string , x ∈ { PARALLEL , SERIAL , SINGLE }
mode	mode	query	string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
autoScreenshots	autoScreenshots	query	boolean
screenshotDir	screenshotDir	query	string
limitationType	limitationType	query	string , x ∈ { PACKAGE , CLASS }
limitationValue	limitationValue	query	string
withAnnotation	withAnnotation	query	string
withoutAnnotation	withoutAnnotation	query	string
applicationUsername	applicationUsername	query	string
applicationPassword	applicationPassword	query	string
usedDeviceGroupId	usedDeviceGroupId	query	integer (int64)
deviceLanguageCode	deviceLanguageCode	query	string
hookURL	hookURL	query	string
uiAutomatorTestClasses	uiAutomatorTestClasses	query	string
launchApp	launchApp	query	boolean
instrumentationRunner	instrumentationRunner	query	string
appRequired	appRequired	query	boolean
timeout	timeout	query	integer (int64)

*/*

200 OK: OK

APITestRunConfig
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project test run config parameters

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config/parameters

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestRunParameter»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add project test run config parameters

POST /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config/parameters

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
key	key	query	string
value	value	query	string

*/*

201 Created: Created

APITestRunParameter
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete project test run config parameter

DELETE /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config/parameters/{parameterId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
parameterId	parameterId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get project test run config parameter

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/config/parameters/{parameterId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
parameterId	parameterId	path	integer (int64)

*/*

200 OK: OK

APITestRunParameter
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run list of user test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs

Tags: device-runs

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the user device run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}

Tags: device-runs

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRun
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the user cluster build logs file

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/cluster-logs

Tags: device-runs

cluster build logs file as response body

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run data availability

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/data-availability

Tags: device-runs

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRunDataAvailability
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the user device run junit file

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/junit.xml

Tags: device-runs

junit file as response body

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the user device run logs file

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/logs

Tags: device-runs

logs file as response body

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the user device run performance file

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/performance

Tags: device-runs

performance file as response body

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the user device run result data file

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/result-data.zip

Tags: device-runs

result data.zip as response body

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the screenshot list of user device run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/screenshots

Tags: device-runs

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIScreenshot»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get user screenshot

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/screenshots/{screenshotId}

Tags: device-runs

screenshot file in response body

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)
screenshotId	screenshotId	path	integer (int64)
width	width	query	integer (int32)
height	height	query	integer (int32)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run state list of the device run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/states

Tags: device-runs

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceRunState»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device run state of user device run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/states/{stateId}

Tags: device-runs

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)
stateId	stepId	path	integer (int64)

*/*

200 OK: OK

APIDeviceRunState
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device run steps

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-runs/{deviceRunId}/test-case-runs

Tags: device-runs

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
deviceRunId	deviceRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APITestCaseRun»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session list of user test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions

Tags: device-session

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSession»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get output files for device session by tag

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files

Tags: device-session

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
tag[]	tags	query	string[] , multiple parameters (`tag[]=aaa&tag[]=bbb`)

*/*

200 OK: OK

APIList«APIUserFile»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session output files.zip

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/output-file-set/files.zip

Tags: device-session

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session steps of device session

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps

Tags: device-session

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSessionStep»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the current device session step of device session

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps/current

Tags: device-session

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get the device session step of device session

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/device-sessions/{deviceSessionId}/steps/{deviceSessionStepId}

Tags: device-session

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)
deviceSessionStepId	deviceSessionStepId	path	integer (int64)

*/*

200 OK: OK

APIDeviceSessionStep
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get list of files in user test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files

Tags: file

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK

APIFiles
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get zip file with artifacts of user test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files.zip

Tags: file

zip stream is returned

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get application file in user project

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files/application

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get application file in user project

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files/application/check-results

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get data file in user project

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files/data

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test file in user project

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/files/test

Tags: file

Returns file stream

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get cucumber test run report for calabash project

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/reports/cucumber

Tags: report

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
deviceSessionId	deviceSessionId	query	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get detail failures report for test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/reports/detail-failures

Tags: report

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get failures report for test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/reports/failures

Tags: report

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get summary report for test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/reports/summary

Tags: report

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	runId	path	integer (int64)
preview	preview	query	boolean
type	reportType	query	string , x ∈ { HTML , PDF , CSV }

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get screenshot names

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/screenshot-names

Tags: device-runs

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIScreenshot»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run screenshots by name

GET /api/v2/users/{userId}/projects/{projectId}/runs/{runId}/screenshots

Tags: device-runs

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
runId	testRunId	path	integer (int64)
name	name	query	string

*/*

200 OK: OK

APIList«APIScreenshotExtended»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating apps and data zip from user's test run

POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/apps-data.zip

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run data availability

GET /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/data-availability

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)

*/*

200 OK: OK

APITestRunDataAvailability
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Retry session for device

POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/device-sessions/{deviceSessionId}/retry

Tags: device-session

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceSessionId	deviceSessionId	path	integer (int64)

*/*

200 OK: APIDeviceSession
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating files zip from user's test run

POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/files.zip

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating logs zip from user's test run

POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/logs.zip

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating performance zip from user's test run

POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/performance.zip

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Retry test run or its device runs

POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/retry

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Request for generating screenshot zip from user's test run

POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/screenshots.zip

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
deviceRunIds[]	deviceRunIds	query	integer[] , multiple parameters (`deviceRunIds[]=aaa&deviceRunIds[]=bbb`)

*/*

200 OK: OK

APIUserFile
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Start test run

POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/start

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
usedDeviceIds[]	deviceIds	query	integer[] , multiple parameters (`usedDeviceIds[]=aaa&usedDeviceIds[]=bbb`)

*/*

200 OK: APITestRun
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get device session steps of all device sessions in run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/steps

Tags: device-session

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APIDeviceSessionStep»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get test run tag list from user's test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/tags

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)

*/*

200 OK: OK

APIList«APITag»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Add test run tag to user's test run

POST /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/tags

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
name	name	query	string

*/*

201 Created: Created

APITag
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete test run tag from user's test run

DELETE /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/tags/{tagId}

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
tagId	tagId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get test run tag from user's test run

GET /api/v2/users/{userId}/projects/{projectId}/runs/{testRunId}/tags/{tagId}

Tags: test-run

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
testRunId	testRunId	path	integer (int64)
tagId	tagId	path	integer (int64)

*/*

200 OK: OK

APITag
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get project sharings of user specified by ID

GET /api/v2/users/{userId}/projects/{projectId}/sharings

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)

*/*

200 OK: OK

APIList«APIProjectSharing»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Share project to specified by email

POST /api/v2/users/{userId}/projects/{projectId}/sharings

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
email	email	query	string

*/*

201 Created: Created

APIProjectSharing
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Delete project sharing of user specified by ID

DELETE /api/v2/users/{userId}/projects/{projectId}/sharings/{sharingId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
sharingId	sharingId	path	integer (int64)

*/*

204 No Content: No Content
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden

Get project sharing of user specified by ID

GET /api/v2/users/{userId}/projects/{projectId}/sharings/{sharingId}

Tags: project

application/json


userId	userId	path	integer (int64)
projectId	projectId	path	integer (int64)
sharingId	sharingId	path	integer (int64)

*/*

200 OK: OK

APIProjectSharing
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Get receipt for users service

GET /api/v2/users/{userId}/receipts

Tags: user

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK

APIList«APIAccountService»
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Buy service

POST /api/v2/users/{userId}/services

Tags: account-service

application/json


userId	userId	path	integer (int64)
serviceId	serviceId	query	integer (int64)
name	name	query	string
email	email	query	string
phone	phone	query	string
organization	organization	query	string
vat-id	vatId	query	string
country	country	query	string
city	city	query	string
state	state	query	string
address	address	query	string
zip	zip	query	string
paymentMethod	paymentMethod	query	string , x ∈ { PAYPAL , BRAINTREE , INVOICE , PROMOTION }
cardNumber	cardNumber	query	string
expirationDate	expirationDate	query	string
cvv	cvv	query	string
feedback	feedback	query	string

*/*

201 Created: Created

APIServicePaymentStatus
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Load user ui preferences

GET /api/v2/users/{userId}/ui-preferences

Tags: user

application/json


userId	userId	path	integer (int64)

*/*

200 OK: OK
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Store user ui preferences

POST /api/v2/users/{userId}/ui-preferences

Tags: user

application/json


userId	userId	path	integer (int64)
data	data	query	string

*/*

200 OK: OK
201 Created: Created
401 Unauthorized: Unauthorized
403 Forbidden: Forbidden
404 Not Found: Not Found

Schema definitions

Account: object

lastBilledAccountService: AccountService
accountRoles: object[]: AccountRole
users: object[]: User
maxTimeout: integer (int32)
testScreenshotLimit: integer (int32)
accountServices: object[]: AccountService
id: integer (int64)
createTime: string (date-time)

AccountRole: object

name: string
accountService: AccountService
id: integer (int64)
expireTime: string (date-time)
role: Role
startTime: string (date-time)
active: boolean
createTime: string (date-time)

AccountService: object

deactivateReason: string , x ∈ { INITIAL_FAILURE , CHARGE_FAILURE , CANCEL }
billingPeriods: object[]: BillingPeriod
autoRenew: boolean
totalString: string
total: integer (int32)
id: integer (int64)
unit: string , x ∈ { MONTH , DAY , YEAR , HOUR , RUN , PROJECT }
payUnitCount: integer (int32)
rolesIncluded: object[]: AccountRole
unitCount: integer (int32)
lastBillingTime: LocalDateTime
vatRate: integer (int32)
paymentMethod: string , x ∈ { PAYPAL , BRAINTREE , INVOICE , PROMOTION }
payUnitText: string
serviceCount: integer (int32)
nextBillingTime: LocalDateTime
lastPaymentTime: LocalDateTime
finished: boolean
serviceId: integer (int64)
startTime: LocalDateTime
active: boolean
createTime: LocalDateTime
paymentState: string , x ∈ { CREATED , ACTIVATED , RUN , WAITING_FOR_ADDITIONAL_HOURS_PAYMENT , SUBSCRIPTION_NOT_CHARGED , CANCELED }
vat: integer (int32)
endTime: LocalDateTime

AndroidLicense: object

cts: CTSLicense
uiAutomator: UIAutomatorLicense
enabled: boolean
projectLimit: integer (int32)
deviceLimit: integer (int32)
projectLimited: boolean
deviceLimited: boolean

APIAccount: object

testScreenshotLimit: integer (int32)
mainUserName: string
maxTimeout: integer (int32)
mainUserEmail: string
id: integer (int64)
createTime: string (date-time)

APIAccountService: object

deactivateReason: string , x ∈ { INITIAL_FAILURE , CHARGE_FAILURE , CANCEL }
userId: integer (int64)
braintreeId: string
autoRenew: boolean
total: integer (int32)
id: integer (int64)
unit: string , x ∈ { MONTH , DAY , YEAR , HOUR , RUN , PROJECT }
accountId: integer (int64)
lastPaymentTime: string (date-time)
deactivatedByName: string
deactivatedById: integer (int64)
serviceName: string
vatRate: integer (int32)
paymentMethod: string , x ∈ { PAYPAL , BRAINTREE , INVOICE , PROMOTION }
serviceCount: integer (int32)
userEmail: string
activatedByName: string
price: integer (int32)
finished: boolean
serviceId: integer (int64)
startTime: string (date-time)
active: boolean
createTime: string (date-time)
activatedById: integer (int64)
unitCount: integer (int32)
endTime: string (date-time)

APIAccountServicePayment: object

totalPrice: integer (int64)
name: string
additionalTime: integer (int64)
includedTime: integer (int64)
startBillingPeriod: string (date-time)
usedTime: integer (int64)
endBillingPeriod: string (date-time)
id: integer (int64)
accountId: integer (int64)

APIActiveUser: object

country: string
email: string
priority: integer (int32)
timeZone: string
id: integer (int64)
organization: string
loginTime: string (date-time)

APIArray«string»: object

items: string[]: string
id: integer (int64)

APIBasicDeviceTime: object

deviceTime: integer (int64)
id: integer (int64)

APIBasicJiraIssue: object

self: URI
id: integer (int64)
key: string

APIBasicJiraProject: object

self: URI
id: integer (int64)
key: string
name: string

APIBillingPeriod: object

totalPrice: integer (int64)
subscriptionEnd: string (date-time)
subscriptionStart: string (date-time)
additionalHoursPrice: integer (int64)
userId: integer (int64)
paid: boolean
createTime: string (date-time)
startBillingPeriod: string (date-time)
lastPaymentDate: string (date-time)
plan: string
endBillingPeriod: string (date-time)
servicePrice: integer (int64)
mail: string
apiBillingPeriodType: string , x ∈ { BUY , CHARGE , CANCEL }
additionalHours: integer (int64)
paymentMethod: string , x ∈ { PAYPAL , BRAINTREE , INVOICE , PROMOTION }
id: integer (int64)

APICluster: object

name: string
url: string
stateChangeTime: string (date-time)
enabled: boolean
devices: APIAdminList«APIAdminDevice»
state: string , x ∈ { OFFLINE , ONLINE }
id: integer (int64)
stateTime: string (date-time)

APIConnection: object

endTime: string (date-time)
url: string
urlSchema: string
id: integer (int64)
port: integer (int32)
host: string
path: string
password: string
type: string
createTime: string (date-time)
deviceSessionId: integer (int64)

APIDevice: object

imageLeft: integer (int32)
frame160Url: string
displayName: string
frame80Url: string
locked: boolean
imageWidth: integer (int32)
enabled: boolean
creditsPrice: integer (int32)
vncSupported: boolean
imagePrefix: string
osType: string , x ∈ { IOS , ANDROID , UNDEFINED }
aroSupported: boolean
frame100Url: string
imageHeight: integer (int32)
frameExtraWidth: integer (int32)
frame400Url: string
online: boolean
imageTop: integer (int32)
softwareVersion: APISoftwareVersion
id: integer (int64)

APIDeviceGroup: object

displayName: string
name: string
userId: integer (int64)
creditsPrice: integer (int64)
deviceCount: integer (int64)
osType: string , x ∈ { IOS , ANDROID , UNDEFINED }
id: integer (int64)

APIDeviceProperty: object

propertyGroupId: integer (int64)
propertyGroupName: string
displayName: string
id: integer (int64)
name: string

APIDeviceRun: object

testCaseSkippedNo: integer (int32)
deviceName: string
testCaseFailedNo: integer (int32)
interruptedByState: APIDeviceRunState
testCaseSuccessNo: integer (int32)
runStatus: string , x ∈ { WAITING , RUNNING , EXCLUDED , WARNING , FAILED , SUCCEEDED }
testCasePassedNo: integer (int32)
id: integer (int64)
softwareVersion: APISoftwareVersion
currentState: APIDeviceRunState
startTime: string (date-time)
device: APIDevice
launchAppDuration: integer (int64)
testCaseAllNo: integer (int32)
createTime: string (date-time)
deviceSessionId: integer (int64)
deviceSerialId: string

APIDeviceRunDataAvailability: object

logs: boolean
resultsDataZip: boolean
performance: boolean
buildLogs: boolean
deviceRunId: integer (int64)
screenshots: boolean
id: integer (int64)

APIDeviceRunState: object

status: string , x ∈ { STARTED , EXCLUDED , FAILED , SUCCEEDED , NOT_AVAILABLE }
finishTimeMS: integer (int64)
startTimeMS: integer (int64)
deviceRunStateType: string , x ∈ { PREPARING , WAITING , DEVICE_WAITING , DEVICE_DOWNLOAD_TESTSESSION , DEVICE_UNINSTALLING_ALL , DEVICE_REBOOTING , DEVICE_WIFI_CHECKING , DEVICE_ADD_PERMISSIONS , DEVICE_REPACKAGING , DEVICE_TARGET_INSTALLING , DEVICE_TEST_INSTALLING , DEVICE_REMOTECONTROL_RUNNING , DEVICE_RUNNING , DEVICE_SDCARD_COPYING , DEVICE_TARGET_UNINSTALLING , DEVICE_UIAUTOMATOR_RUNNING , DEVICE_TEST_UNINSTALLING , RESULTS_WAITING , RESULTS_PROCESSING , PARSE_LOGCAT , ADB_SHELL_COMMAND }
failReason: string
retryTime: string (date-time)
deviceRunId: integer (int64)
id: integer (int64)

APIDeviceSession: object

deviceInstanceId: integer (int64)
testCaseSkippedCount: integer (int32)
installTime: string (date-time)
testCaseFailedCount: integer (int32)
testCaseSuccessCount: integer (int32)
excludeReason: string
testCaseAllCount: integer (int32)
id: integer (int64)
timeLimit: integer (int64)
state: string , x ∈ { WAITING , RUNNING , EXCLUDED , WARNING , FAILED , SUCCEEDED }
testCasePassedCount: integer (int32)
startTime: string (date-time)
billable: boolean
device: APIDevice
deviceRunId: integer (int64)
endTime: string (date-time)
type: string , x ∈ { INTERACTIVE , AUTOMATIC }
createTime: string (date-time)
launchAppDuration: integer (int64)

APIDeviceSessionStep: object

finishTimeMS: integer (int64)
startTimeMS: integer (int64)
failReason: string
excludeReason: string
type: string , x ∈ { WAITING , PREPARING , UNINSTALL , INSTALL , RUNNING , SENDING_RESULTS , PROCESSING_RESULTS }
id: integer (int64)
deviceSessionId: integer (int64)

APIDeviceStatus: object

deviceName: string
updateTime: string (date-time)
deviceTime: integer (int64)
tetheringOn: boolean
internalStorage: integer (int64)
mockLocationOn: boolean
id: integer (int64)
internetAccess: boolean
ssid: string
alarmOn: boolean
bluetoothOn: boolean
aslOn: boolean
batteryLevel: integer (int32)
emailAccount: string
clusterName: string
sdcardPresent: boolean
deviceId: integer (int64)
testExecuting: boolean
locationServiceOn: boolean
screenLocked: boolean
tdsVersion: string
flashOn: boolean
monitoringOn: boolean
externalStorage: integer (int64)
deviceTimeZone: string

APIDeviceTimeCountSessionReportEntry: object

countTestRuns: integer (int64)
deviceModelName: string
countDeviceSessions: integer (int64)
projectName: string
userEmail: string
day: string (date-time)
deviceTime: integer (int64)
id: integer (int64)

APIDeviceTimeEntry: object

userName: string
deviceTime: integer (int64)
userId: integer (int64)
createTime: string (date-time)
freeTime: integer (int64)
billableTime: integer (int64)
endTime: string (date-time)
type: string , x ∈ { INTERACTIVE , AUTOMATIC }
id: integer (int64)

APIDeviceTimeStepTimeReportEntry: object

userEmail: string
deviceModelName: string
projectName: string
id: integer (int64)
waitingTime: integer (int64)
deviceTime: integer (int64)
preparationTime: integer (int64)
day: string (date-time)

APIEmailNotification: object

users: integer[]: integer (int64)
toggle: boolean
message: string
id: integer (int64)
subject: string

APIEvent: object

eventType: string , x ∈ { RECORDER_OPEN_WIZARD , RECORDER_RUN_IN_CLOUD , RECORDER_FINISH_WIZARD , RECORDER_RUN_APPCRAWLER }
applicationType: string , x ∈ { RECORDER }
id: integer (int64)

APIFile: object

originalName: string
uploadTime: string (date-time)
readableSize: string
id: integer (int64)

APIFiles: object

data: DataFile
id: integer (int64)

APIFileSet: object

name: string
createTime: string (date-time)
fileCount: integer (int64)
id: integer (int64)

APIJiraAccount: object

jiraUrl: string
username: string
hasCertificate: boolean
userId: integer (int64)
id: integer (int64)

APIJiraIssue: object

self: URI
id: integer (int64)
key: string

APIJiraIssueType: object

id: integer (int64)
name: string

APIJiraPriority: object

id: integer (int64)
name: string

APIJiraProject: object

name: string
self: URI
description: string
key: string
id: integer (int64)
leadName: string

APIJiraServerInfo: object

baseUri: URI
version: string
id: integer (int64)

APILabelGroup: object

hiddenByDefault: boolean
displayName: string
id: integer (int64)
name: string

APILicense: object

status: string , x ∈ { ACTIVE , EXPIRED , INACTIVE }
appium: AppiumLicense
activateTime: string (date-time)
userId: integer (int64)
privateInstance: boolean
selenium: SeleniumLicense
ios: IOSLicense
userEmail: string
server: ServerLicense
recorder: RecorderLicense
expireTime: string (date-time)
autoRenew: boolean
remoteControl: RemoteControlLicense
android: AndroidLicense
calabash: CalabashLicense
expired: boolean
id: integer (int64)
inspector: InspectorLicense

APIList«APIAccountService»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIAccountService
id: integer (int64)
empty: boolean
previous: string

APIList«APIBillingPeriod»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIBillingPeriod
id: integer (int64)
empty: boolean
previous: string

APIList«APIConnection»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIConnection
id: integer (int64)
empty: boolean
previous: string

APIList«APIDeviceGroup»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIDeviceGroup
id: integer (int64)
empty: boolean
previous: string

APIList«APIDeviceProperty»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIDeviceProperty
id: integer (int64)
empty: boolean
previous: string

APIList«APIDeviceRunState»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIDeviceRunState
id: integer (int64)
empty: boolean
previous: string

APIList«APIDeviceRun»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIDeviceRun
id: integer (int64)
empty: boolean
previous: string

APIList«APIDeviceSessionStep»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIDeviceSessionStep
id: integer (int64)
empty: boolean
previous: string

APIList«APIDeviceSession»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIDeviceSession
id: integer (int64)
empty: boolean
previous: string

APIList«APIDeviceTimeCountSessionReportEntry»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIDeviceTimeCountSessionReportEntry
id: integer (int64)
empty: boolean
previous: string

APIList«APIDeviceTimeStepTimeReportEntry»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIDeviceTimeStepTimeReportEntry
id: integer (int64)
empty: boolean
previous: string

APIList«APIDevice»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIDevice
id: integer (int64)
empty: boolean
previous: string

APIList«APIFileSet»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIFileSet
id: integer (int64)
empty: boolean
previous: string

APIList«APIJiraIssue»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIJiraIssue
id: integer (int64)
empty: boolean
previous: string

APIList«APILabelGroup»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APILabelGroup
id: integer (int64)
empty: boolean
previous: string

APIList«APILicense»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APILicense
id: integer (int64)
empty: boolean
previous: string

APIList«APINotificationEmail»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APINotificationEmail
id: integer (int64)
empty: boolean
previous: string

APIList«APIProjectJobConfig»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIProjectJobConfig
id: integer (int64)
empty: boolean
previous: string

APIList«APIProjectSharing»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIProjectSharing
id: integer (int64)
empty: boolean
previous: string

APIList«APIProject»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIProject
id: integer (int64)
empty: boolean
previous: string

APIList«APIRole»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIRole
id: integer (int64)
empty: boolean
previous: string

APIList«APIScreenshotExtended»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIScreenshotExtended
id: integer (int64)
empty: boolean
previous: string

APIList«APIScreenshot»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIScreenshot
id: integer (int64)
empty: boolean
previous: string

APIList«APIService»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIService
id: integer (int64)
empty: boolean
previous: string

APIList«APITag»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APITag
id: integer (int64)
empty: boolean
previous: string

APIList«APITestCaseRunStep»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APITestCaseRunStep
id: integer (int64)
empty: boolean
previous: string

APIList«APITestCaseRun»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APITestCaseRun
id: integer (int64)
empty: boolean
previous: string

APIList«APITestRunExtended»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APITestRunExtended
id: integer (int64)
empty: boolean
previous: string

APIList«APITestRunParameter»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APITestRunParameter
id: integer (int64)
empty: boolean
previous: string

APIList«APITestRun»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APITestRun
id: integer (int64)
empty: boolean
previous: string

APIList«APIUserFileTag»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIUserFileTag
id: integer (int64)
empty: boolean
previous: string

APIList«APIUserFile»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIUserFile
id: integer (int64)
empty: boolean
previous: string

APIList«APIUser»: object

sort: string
search: string
next: string
limit: integer (int32)
offset: integer (int32)
total: integer (int32)
data: object[]: APIUser
id: integer (int64)
empty: boolean
previous: string

APINotificationEmail: object

project: APIProject
type: string , x ∈ { ALWAYS , ON_FAILURE }
email: string
id: integer (int64)

APIProject: object

archivingItemCount: integer (int32)
sharedById: integer (int64)
description: string
archiveTime: string (date-time)
sharedByEmail: string
archivingStrategy: string , x ∈ { NEVER , DAYS , RUNS }
id: integer (int64)
archivingStrategyDisplayValue: string
common: boolean
type: string , x ∈ { ANDROID , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
createTime: string (date-time)
name: string

APIProjectJobConfig: object

lastModifiedBy: string
global: boolean
projectId: integer (int64)
lastModificationTime: string (date-time)
content: string
version: integer (int32)
projectName: string
type: string , x ∈ { DEFAULT , INSTATEST , INTERACTIVE , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
id: integer (int64)

APIProjectSharing: object

userEmail: string
userId: integer (int64)
id: integer (int64)

APIProperty: object

updateTime: string (date-time)
description: string
value: string
updatedById: integer (int64)
updatedByDisplayName: string
toTime: string (date-time)
fromTime: string (date-time)
id: integer (int64)
name: string

APIRole: object

expireTime: string (date-time)
id: integer (int64)
name: string
addedByEmail: string

APIScreenshot: object

fail: boolean
originalName: string
type: string , x ∈ { LANDSCAPE , PORTRAIT }
id: integer (int64)
takeTimestamp: integer (int64)

APIScreenshotExtended: object

testRunId: integer (int64)
projectId: integer (int64)
fail: boolean
takeTimestamp: integer (int64)
device: APIDevice
deviceRunId: integer (int64)
type: string , x ∈ { LANDSCAPE , PORTRAIT }
id: integer (int64)
originalName: string

APIService: object

activateTime: string (date-time)
description: string
archiveTime: string (date-time)
includedHours: integer (int32)
pricePerHour: integer (int32)
priceString: string
centPrice: integer (int32)
braintreeId: string
autoRenew: boolean
unitCount: integer (int32)
customPlan: boolean
id: integer (int64)
unit: string , x ∈ { MONTH , DAY , YEAR , HOUR , RUN , PROJECT }
name: string

APIServicePaymentStatus: object

accountService: APIAccountService
status: string , x ∈ { SUCCEEDED , FAILED , REDIRECTED }
message: string
redirectionPostData: string
redirectionUrl: string

APISession: object

ip: string
userId: integer (int64)
logoutTime: string (date-time)
headers: string
sessionId: string
email: string
id: integer (int64)
loginTime: string (date-time)

APISoftwareVersion: object

apiLevel: integer (int32)
releaseVersion: string
id: integer (int64)

APITag: object

id: integer (int64)
name: string

APITestCaseRun: object

stacktrace: string
methodName: string
errorMessage: string
suiteName: string
id: integer (int64)
className: string
steps: APIList«APITestCaseRunStep»
result: string , x ∈ { PASSED , FAILED , SKIPPED , NOT_AVAILABLE }
duration: number (double)
createTime: string (date-time)

APITestCaseRunStep: object

description: string
type: string , x ∈ { ASSERTION , CLICK , CONFIG , DRAG , INPUT , NAVIGATION , OTHER , SCROLL , UTIL , WAIT }
errorMessage: string
fromActivity: string
duration: integer (int64)
screenshots: APIList«APIScreenshot»
id: integer (int64)

APITestRun: object

testCaseCount: integer (int32)
displayName: string
state: string , x ∈ { WAITING , RUNNING , FINISHED }
projectId: integer (int64)
screenshotsFileId: integer (int64)
errorsDeviceCount: integer (int32)
successRatio: number (float)
id: integer (int64)
executionRatio: number (float)
excludedDeviceCount: integer (int32)
number: integer (int32)
successfulTestCaseCount: integer (int32)
finishedDeviceCount: integer (int32)
startedByDisplayName: string
logsFileId: integer (int64)
totalDeviceCount: integer (int32)
createTime: string (date-time)

APITestRunConfig: object

uiAutomatorTestClasses: string
autoScreenshots: boolean
id: integer (int64)
withAnnotation: string
screenshotDir: string
projectId: integer (int64)
withoutAnnotation: string
applicationUsername: string
runAvailable: boolean
instrumentationRunner: string
launchApp: boolean
limitationType: string , x ∈ { PACKAGE , CLASS }
creditsPrice: integer (int64)
hookURL: string
gamebenchEnabled: boolean
scheduler: string , x ∈ { PARALLEL , SERIAL , SINGLE }
checkApp: boolean
videoRecordingEnabled: boolean
deviceLanguageCode: string
useAdditionalFiles: boolean
appRequired: boolean
usedDeviceGroupId: integer (int64)
applicationPassword: string
mode: string , x ∈ { FULL_RUN , APP_CRAWLER , CTS , IOS , UIAUTOMATOR , REMOTECONTROL , CALABASH , CALABASH_IOS , APPIUM_ANDROID , APPIUM_IOS , IOS_CRAWLER , TELERIK_ANDROID , TELERIK_IOS , GENERIC }
timeout: integer (int64)
limitationValue: string

APITestRunDataAvailability: object

test: boolean
application: boolean
deviceRunDataAvailabilities: object[]: APIDeviceRunDataAvailability
id: integer (int64)
testRunId: integer (int64)

APITestRunExtended: object

files: APIFiles
testCaseCount: integer (int32)
displayName: string
state: string , x ∈ { WAITING , RUNNING , FINISHED }
projectId: integer (int64)
screenshotsFileId: integer (int64)
errorsDeviceCount: integer (int32)
successRatio: number (float)
id: integer (int64)
deviceCount: integer (int32)
executionRatio: number (float)
excludedDeviceCount: integer (int32)
number: integer (int32)
successfulTestCaseCount: integer (int32)
finishedDeviceCount: integer (int32)
startedByDisplayName: string
logsFileId: integer (int64)
totalDeviceCount: integer (int32)
createTime: string (date-time)
tags: object[]: APITag

APITestRunParameter: object

value: string
id: integer (int64)
key: string

APIUser: object

code: string
apiKey: string
isMainUser: boolean
id: integer (int64)
accountId: integer (int64)
city: string
state: string
mainUserId: integer (int64)
lastLoginTime: string (date-time)
email: string
status: string , x ∈ { INACTIVE , DISABLED , ENABLED }
activeServiceId: integer (int64)
timeZone: string
phone: string
address: string
emailNotification: string , x ∈ { ALWAYS , NEVER , ON_FAILURE }
createTime: string (date-time)
name: string
roles: object[]: APIRole
country: string
enabled: boolean
mainUserEmail: string
organization: string
vatID: string

APIUserDeviceTime: object

inspectorDeviceTime: integer (int64)
deviceTimeEntries: object[]: APIDeviceTimeEntry
periodStart: integer (int64)
periodEnd: integer (int64)
freeDeviceTime: integer (int64)
totalDeviceTime: integer (int64)
id: integer (int64)
automaticDeviceTime: integer (int64)

APIUserFile: object

name: string
createTime: string (date-time)
fileProperties: object[]: APIUserFileProperty
state: string , x ∈ { PREPARING , READY }
directUrl: URL
id: integer (int64)
size: integer (int64)

APIUserFileProperty: object

value: string
id: integer (int64)
key: string

APIUserFileTag: object

id: integer (int64)
name: string

AppiumLicense: object

enabled: boolean

BillingPeriod: object

totalPrice: integer (int64)
billingPeriodStart: LocalDateTime
subscriptionEnd: LocalDateTime
subscriptionStart: LocalDateTime
additionalTime: integer (int64)
billingPeriodEnd: LocalDateTime
id: integer (int64)
servicePrice: integer (int64)
paymentDate: LocalDateTime
additionalHoursPrice: integer (int64)
additionalHoursPaymentDate: LocalDateTime
paymentMethod: string , x ∈ { PAYPAL , BRAINTREE , INVOICE , PROMOTION }
createTime: LocalDateTime

CalabashLicense: object

enabled: boolean

Chronology: object

zone: DateTimeZone

CTSLicense: object

enabled: boolean

DataFile: object

originalName: string
uploadTime: string (date-time)
readableSize: string
id: integer (int64)

DateTimeField: object

supported: boolean
name: string
durationField: DurationField
rangeDurationField: DurationField
maximumValue: integer (int32)
lenient: boolean
minimumValue: integer (int32)
type: DateTimeFieldType
leapDurationField: DurationField

DateTimeFieldType: object

durationType: DurationFieldType
name: string
rangeDurationType: DurationFieldType

DateTimeZone: object

fixed: boolean
id: string

DurationField: object

precise: boolean
unitMillis: integer (int64)
supported: boolean
type: DurationFieldType
name: string

DurationFieldType: object

name: string

InspectorLicense: object

enabled: boolean

IOSLicense: object

deviceLimit: integer (int32)
projectLimit: integer (int32)
enabled: boolean
deviceLimited: boolean
projectLimited: boolean

LocalDateTime: object

dayOfWeek: integer (int32)
millisOfDay: integer (int32)
millisOfSecond: integer (int32)
secondOfMinute: integer (int32)
fields: object[]: DateTimeField
weekyear: integer (int32)
year: integer (int32)
fieldTypes: object[]: DateTimeFieldType
chronology: Chronology
yearOfCentury: integer (int32)
yearOfEra: integer (int32)
dayOfYear: integer (int32)
values: integer[]: integer (int32)
era: integer (int32)
centuryOfEra: integer (int32)
hourOfDay: integer (int32)
weekOfWeekyear: integer (int32)
minuteOfHour: integer (int32)
monthOfYear: integer (int32)
dayOfMonth: integer (int32)

RecorderLicense: object

limit: integer (int32)
enabled: boolean
limited: boolean

RemoteControlLicense: object

enabled: boolean

Role: object

serviceRoles: object[]: ServiceRole
accountRoles: object[]: AccountRole
id: integer (int64)
name: string

SeleniumLicense: object

enabled: boolean

ServerLicense: object

iosEnabled: boolean
androidEnabled: boolean
enabled: boolean

Service: object

archived: boolean
serviceRoles: object[]: ServiceRole
activateTime: string (date-time)
description: string
archiveTime: string (date-time)
includedHours: integer (int32)
price: integer (int32)
pricePerHour: integer (int32)
accountServices: object[]: AccountService
id: integer (int64)
autoRenew: boolean
unitCount: integer (int32)
inactive: boolean
roles: object[]: Role
customPlan: boolean
active: boolean
braintreePlanId: string
createTime: string (date-time)
unit: string , x ∈ { MONTH , DAY , YEAR , HOUR , RUN , PROJECT }
name: string

ServiceRole: object

service: Service
unitCount: integer (int32)
serviceCount: integer (int32)
id: integer (int64)
createTime: string (date-time)
unit: string , x ∈ { MONTH , DAY , YEAR , HOUR , RUN , PROJECT }

UIAutomatorLicense: object

enabled: boolean

URI: object

rawAuthority: string
rawQuery: string
opaque: boolean
fragment: string
rawFragment: string
rawSchemeSpecificPart: string
authority: string
rawUserInfo: string
rawPath: string
host: string
userInfo: string
query: string
path: string
schemeSpecificPart: string
scheme: string
port: integer (int32)
absolute: boolean

URL: object

protocol: string
authority: string
content: object
defaultPort: integer (int32)
host: string
userInfo: string
file: string
query: string
path: string
ref: string
port: integer (int32)

User: object

apiKey: string
availableHearFromValues: string[]: string
lastAccountChange: string (date-time)
code: string
displayLocaleCountry: string
id: integer (int64)
Status: string
city: string
accountRoles: object[]: AccountRole
billing: boolean
Organization role: string
state: string
vatRate: integer (int32)
email: string
countryDisplayname: string
displayname: string
timeZone: string
Heard from: string
phone: string
registrationIP: string
address: string
active: boolean
password: string
createTime: string (date-time)
availableOrganizationRoleValues: string[]: string
account: Account
name: string
country: string
recoveryKey: string
organizationRole: string , x ∈ { CEO_OR_OWNER , VP , MANAGER , INDIVIDUAL , QUALITY_ASSURANCE , DEVELOPER , MARKETING , CONSULTANT , OTHER }
hearFrom: string , x ∈ { COWORKER , EMAIL_CAMPAIGN , EVENT , ONLINE_COMMUNITY , SOCIAL_NETWORK , WEB_SEARCH , OTHER }
organization: string